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

Returned from POST /api/agents/signup. Contains the newly-created agent user’s profile, an access token the CLI persists for future API calls, and an opaque claim token the human submits to take ownership of the account.

Properties

• accessToken string required
  The Pulumi access token to use for authenticating future API requests as the new user.
• accessTokenValidUntil string required
  When the temporary access token expires.
• claimToken string required
  An opaque single-use token the human submits to claim ownership of the account. The CLI surfaces a claim URL embedding this token to the human; the path is a CLI/UI concern.
• claimTokenValidUntil string required
  When the claim token expires.
• userInfo User required
  The newly-created user’s profile information.
• ↳ 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.
• ↳ potentialOrganizations array[OrganizationSummaryWithRole] optional
  PotentialOrganizations is the list of Pulumi organizations the user is a potential member of.
• ↳ 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
• ↳ 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.