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

User represents a Pulumi user. This structure contains the full, private information that will be used only for an authenticated user. As a result, sensitive information (like email) is permitted.

Properties

• id string required
  The unique identifier of the user.
• githubLogin string required
  The user’s login name (originally from GitHub).
• name string required
  The user’s display name.
• email string required
  The user’s email address.
• avatarUrl string required
  The URL of the user’s avatar image.
• organizations array[OrganizationSummaryWithRole] required
  Organizations is the list of Pulumi organizations the user is a member of.
• ↳ 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.
• potentialOrganizations array[OrganizationSummaryWithRole] optional
  PotentialOrganizations is the list of Pulumi organizations the user is a potential member of.
• ↳ 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.
• identities array[string] required
  Identities is the array of identities a Pulumi user’s account is tied to.
• siteAdmin boolean optional
  SiteAdministrator is whether or not the user is a site administrator.
• registryAdmin boolean optional
  RegistryAdmin is whether or not the user is a registry administrator.
• tokenInfo TokenInfo optional
  TokenInfo is contains metadata, set only for machine tokens & to be used only in the CLI
• ↳ name string required
  The name of the access token.
• ↳ organization string required
  The organization the token is scoped to, if any.
• ↳ team string required
  The team the token is scoped to, if any.
• hasMFA boolean required
  Whether the user has multi-factor authentication enabled.
• isOrgManaged boolean required
  Whether the user’s account is managed by an organization.
• isManagedByMultiOrg boolean required
  Whether the user’s account is managed by multiple organizations.
• isAgent boolean optional
  Whether the user is a synthetic agent account. Agent accounts cannot be authenticated except via their issued access token until a human claims the account via the claim URL.