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

OrganizationSummary is just the display information for an organization.

Properties

• name string required
  The name of the organization.
• role enum required
  The role of the user within this organization.
  Values:

  none — None

  OrganizationRoleNone describes the role of non-members.

  member — Member

  OrganizationRoleMember is the role for regular members.

  admin — Admin

  OrganizationRoleAdmin is the role for admins.

  potential-member — PotentialMember

  OrganizationRolePotentialMember is the role for users who are explicitly not a member of the organization, but are a member of the backing org on the 3rd party identity provider. (i.e. they could join the org.)

  stack-collaborator — StackCollaborator

  OrganizationRoleStackCollaborator is the role for users who are not a member of an organization, but have been explicitly granted access to some of the organization’s stacks. So they have limited permissions to access the org’s data.

  billing-manager — BillingManager

  OrganizationRoleBillingManager is the role for billing admins.

• githubLogin string required
  The GitHub login associated with the organization.
• avatarUrl string required
  The URL of the organization’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.