invitations

Get an invitation sent to the signed-in user.

The full invitation, including the invitee's and inviter's email addresses and the role it grants. Only the invited recipient (the signed-in user whose email matches, without regard to case) may read it. An unknown id, an id that is not a UUID, an invitation that is no longer pending, and an invitation sent to someone else are all answered with the same 404, so this never confirms that an invitation exists to anyone but its recipient. Service accounts are refused with a 403 (service_account_forbidden).

get/invitations/{invitationId}

Request

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

Response

The invitation.

idstring uuid required

The ID of the invitation.

organization_idinteger nullable required

The organization the invitation is to, or null for an app invitation.

app_idstring nullable required

The app the invitation is to, or null for an organization invitation.

target_namestring required

The organization's name or the app's display name.

inviter_emailstring required

The email of the user who sent the invitation.

emailstring required

The email address the invitation was sent to.

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

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

expires_atstring date-time required

When the invitation stops being valid.

Changes

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