Organizations
Invites

CreateOrgInviteLink

Generates a new invite URL to join an organization, intended to be shared via copy/paste. Does not send out an email and does not require an email address in the request. Anyone with a Pulumi account who knows the resulting URL can accept the invitation, so share the link only with the intended recipient.

post/api/orgs/{orgName}/invites/link

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/link
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

Request body

emailstring

The email address. Required for email-based invites, omitted when creating shareable invite links.

role'member' | 'admin' | 'billing-manager' required

Built-in role to assign to the invited member. When 'roleId' is also supplied it takes precedence and this field is ignored; prefer 'roleId' for new integrations.

roleIdstring

UUID of a role (built-in or custom) to assign to the invited member. Takes precedence over 'role' when both are supplied.

Response

OK

acceptInviteUrlstring required

The accept invite URL

idstring required

The unique identifier

Changes

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