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

ListTeamsWithRoleResponse

    ListTeamsWithRoleResponse is the shape of the response when listing teams with a given role within an organization.

    Properties

    • teams array[Team] required
      Teams that are backed by the given role.
    • 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.
    • stacks array[TeamStackPermission] optional
      The list of stack permissions granted to the team.
    • environments array[TeamEnvironmentSettings] optional
      The list of environment settings for the team.
    • accounts array[TeamAccountPermission] optional
      The list of account permissions granted to the team.
    • 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.