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

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, pulumi, scim
    • 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
      IMPORTANT: The email address of the user is only included on a few admin-only APIs. For nearly all APIs that return a UserInfo object, this will not be provided. considered 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).
      Values: 0, 101, 102, 103, 104
    • ↳ 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.
      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, 1, 2, 3
    • ↳ 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.