1. Docs
2. Reference
3. REST API Docs
4. Schema
5. Team

Team describes a Pulumi team. A Pulumi team may have its organization managed by another service, such as GitHub.

Properties

• kind enum required
  The kind of team (e.g., pulumi or GitHub-backed).
  Values:

  github — GitHub

  TeamKindGitHub is for teams where membership is managed by GitHub.

  pulumi — Pulumi

  TeamKindPulumi is for teams where membership is managed by Pulumi.

  scim — SCIM

  TeamKindSCIM is for SCIM provisioned teams. Membership is managed by its IdP.

• name string required
  The unique identifier name of the team within the organization.
• displayName string required
  The human-readable display name shown in the UI.
• description string required
  A free-form text description of the team’s purpose.
• members array[TeamMemberInfo] optional
  The list of team members.
• ↳ name string required
  The user’s display name.
• ↳ role enum required
  The member’s role within the team.
  Values: none, member, admin
• ↳ githubLogin string required
  The user’s login name.
• ↳ avatarUrl string required
  The URL of the user’s avatar image.
• ↳ email string optional
  The user’s email address. It is only populated on selected endpoints and is omitted from most responses. Treat it as sensitive information.
• stacks array[TeamStackPermission] optional
  The list of stack permissions granted to the team.
• ↳ projectName string required
  The project containing the stack.
• ↳ stackName string required
  The stack within the project.
• ↳ permission enum required
  The permission level the team has on this stack (e.g., read, write, admin). On editStackPermission, set to “none” to remove the stack from the team. addStackPermission ignores “none” — including an omitted permission, which reads as “none” — and stores nothing: adding is how a grant is created, and removeStack is how one is revoked.
  Values:

  0 — None

  StackPermissionNone provides no access.

  101 — Read

  StackPermissionRead provides read-only access, including the ability to decrypt encrypted configuration secrets stored in the service.

  102 — Write

  StackPermissionWrite provides read/write access to a stack.

  103 — Admin

  StackPermissionAdmin provides admin-level access to the stack. For example, being able to run pulumi destroy or delete the stack.

  104 — Creator

  StackPermissionCreator identifies the user who created the stack. It confers the same access as StackPermissionAdmin.

• ↳ permissionSetName string optional
  Display name of the permission set for this stack, when available. Enables read-only entity access UI without requiring RoleRead.
• environments array[TeamEnvironmentSettings] optional
  The list of environment settings for the team.
• ↳ projectName string required
  The project containing the environment.
• ↳ envName string required
  The environment within the project.
• ↳ permission enum required
  The permission level the team has on this environment. On editEnvironmentPermission, set to “none” to remove the environment from the team. addEnvironmentPermission ignores “none” and stores nothing: adding is how a grant is created, and removeEnvironment is how one is revoked.
  Values: none, read, open, write, admin
• ↳ maxOpenDuration string optional
  The maximum duration an environment session can remain open, as a Go duration string (e.g. “1h30m”).
• ↳ permissionSetName string optional
  Display name of the permission set for this environment, when available. Enables read-only entity access UI without requiring RoleRead.
• accounts array[TeamAccountPermission] optional
  The list of account permissions granted to the team.
• ↳ accountName string required
  The Insights account name.
• ↳ permission enum required
  The permission level the team has on this Insights account.
  Values:

  0 — None

  InsightsAccountPermissionNone provides no access.

  1 — Read

  InsightsAccountPermissionRead provides read-only access.

  2 — Write

  InsightsAccountPermissionWrite provides read/write access to an account.

  3 — Admin

  InsightsAccountPermissionAdmin provides admin-level access to the account.

• ↳ permissionSetName string optional
  Display name of the permission set for this account, when available. Enables read-only entity access UI without requiring RoleRead.
• listMembersError string optional
  ListMembersError is the error message if an error was encountered whilst trying to contact the team’s backend (eg. GitHub). The UI will only show this error if it is non-nil and if Members itself is an empty slice.
• userRole enum optional
  UserRole is the calling user’s role on the given team.
  Values: none, member, admin
• roleIds array[string] optional
  RoleIDs are the IDs of the FGA roles assigned to the team, if any. Currently only one role per team is supported.