organizations

Invite someone to join an organization.

Emails an invitation to join the team organization with the given role. The invitation is valid for 14 days; the invitee accepts it with POST /invitations/{invitationId}/accept. Requires the invitations.create permission, which the admin and owner roles hold.

The owner role cannot be granted by invitation. Inviting anyone needs the organization's plan to include collaboration, and roles other than developer must be offered by that plan. When the organization restricts members to allowed email domains, the email must be in one of them. An organization holds at most 50 pending invitations.

When the organization belongs to an enterprise and the email is an account already in that enterprise's directory, no invitation is sent: the account is added as a member at the role at once, and the response's type is member rather than invitation.

post/organizations/{organizationId}/invitations

Request

  • Base URL
    https://api.shorebird.dev/api/v1
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

emailstring email required

The email address to send the invitation to.

role'owner' | 'admin' | 'appManager' | 'developer' | 'viewer' | 'auditor' | 'scim' | 'none' required

A role that a user can have relative to an Organization or App.

Response

The invitation was created and sent (type invitation), or the account, being in the directory of the organization's enterprise, was added as a member (type member).

OR

Changes

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