Services

Returns all service accounts in an organization. Service accounts provide programmatic, non-human identities for accessing Pulumi Cloud resources. They can hold access tokens, belong to teams, and have stack permissions, making them suitable for CI/CD pipelines, automation tools, and other machine-to-machine integrations.

Request Parameters

• orgName string path required
  The organization name

Responses

Creates a new service account in an organization. Service accounts provide programmatic, non-human identities for accessing Pulumi Cloud resources. They are scoped to an organization and can hold access tokens, belong to teams, and have stack permissions. The service name must be unique within the organization.

Request Parameters

• orgName string path required
  The organization name

Request Body

• ownerType string required
  the service owner type
• ownerName string required
  the service owner name
• name string required
  the name of the service
• description string required
  an optional description of the service
• items array[AddServiceItem] required
  an optional list of items to add during service creation
• ↳ type string required
  the type of the item to add
• ↳ name string required
  the name (including any namespacing) of the item
• properties array[ServiceProperty] required
  an optional list of properties to set on the service
• ↳ key string required
  the name of the property
• ↳ value string required
  the value of the property
• ↳ type string required
  the type of the property
• ↳ order integer required
  the position of the property

Responses

Returns the details of a specific service account, including its name, owner, description, team memberships, access tokens, and stack permissions. Service accounts provide programmatic, non-human access to Pulumi Cloud resources and are identified by their owner type, owner name, and service name.

Request Parameters

• orgName string path required
  The organization name
• ownerType string path required
  The owner type
• ownerName string path required
  The owner name
• serviceName string path required
  The service name

Responses

Updates the metadata and configuration of an existing service account, such as its description, team memberships, and access settings. Service accounts provide programmatic, non-human access to Pulumi Cloud resources.

Request Parameters

• orgName string path required
  The organization name
• ownerType string path required
  The owner type
• ownerName string path required
  The owner name
• serviceName string path required
  The service name

Request Body

• name string optional
  the name of the service
• description string optional
  an optional description of the service
• properties array[ServiceProperty] optional
  an optional list of properties to set on the service
• ↳ key string required
  the name of the property
• ↳ value string required
  the value of the property
• ↳ type string required
  the type of the property
• ↳ order integer required
  the position of the property

Responses

Deletes a service account from an organization. Service accounts provide programmatic, non-human access to Pulumi Cloud resources. If the service has other members, deletion requires explicit confirmation via the force parameter. All access tokens and permissions associated with the service are revoked.

Request Parameters

• orgName string path required
  The organization name
• ownerType string path required
  The owner type
• ownerName string path required
  The owner name
• serviceName string path required
  The service name
• force boolean query optional
  Force deletion even if the service has other members

Responses

Checks whether a service account exists in the organization without returning its full details. Returns 204 No Content if the service exists, or an error if not found. This is a lightweight check useful for validating service account references.

Request Parameters

• orgName string path required
  The organization name
• ownerType string path required
  The owner type
• ownerName string path required
  The owner name
• serviceName string path required
  The service name

Responses

Adds items (such as access tokens, team memberships, or stack permissions) to an existing service account. Service accounts provide programmatic, non-human access to Pulumi Cloud resources and are scoped to an organization. Items define what the service account can access and what credentials it holds. Returns the updated service details.

Request Parameters

• orgName string path required
  The organization name
• ownerType string path required
  The owner type
• ownerName string path required
  The owner name
• serviceName string path required
  The service name

Request Body

• items array[AddServiceItem] required
  List of items
• ↳ type string required
  the type of the item to add
• ↳ name string required
  the name (including any namespacing) of the item

Responses

Removes a specific item (such as a team membership, access token, or stack permission) from a service account. Returns the updated service details after the item has been removed.

Request Parameters

• orgName string path required
  The organization name
• ownerType string path required
  The owner type
• ownerName string path required
  The owner name
• serviceName string path required
  The service name
• itemType string path required
  The item type
• itemName string path required
  The item name

Responses