Organizations
Invites

GetOrgInvite

Validates the organization name and invite ID from the URL and, if they correspond to an active invitation, returns basic organization metadata. This provides a reasonably secure way to share organization metadata with a non-member without making it available to everyone, since the caller must know both the organization login and the invite ID. Returns 404 if the invite has already been accepted or canceled.

get/api/orgs/{orgName}/invites/{inviteID}

Request

  • Base URL: https://api.pulumi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pulumi.com/api/orgs/{orgName}/invites/{inviteID}
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

inviteIDstring required

The invite identifier

Response

OK

avatarUrlstring required

The URL of the organization's avatar image.

emailstring

The user's email address. It is only populated on selected endpoints and is omitted from most responses. Treat it as sensitive information.

githubLoginstring required

The GitHub login associated with the organization.

namestring required

The name of the organization.

role'none' | 'member' | 'admin' | 'potential-member' | 'stack-collaborator' | 'billing-manager' required

The role of the user within this organization.

Changes

No recorded changes to this operation across all 1 revision of this API.