Sign in
Control

Changed on
post/v1/control/organizations/{organization_id}/invitations

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/control/organizations/{organization_id}/invitations
  • Auth: one of:
    • HTTP bearer
    • API key in cookie p93_control_access

Request body

emailstring email required
role'owner' | 'admin' | 'member' | 'auditor' required
onboarding_method'email' | 'google' | 'apple' | 'microsoft' | 'facebook' | 'linkedin'
expires_ininteger

Response

Invitation queued and credential returned once

idstring uuid required
organization_idstring uuid nullable
emailstring email required
role'owner' | 'admin' | 'member' | 'auditor' required
onboarding_method'email' | 'google' | 'apple' | 'microsoft' | 'facebook' | 'linkedin' required
status'pending' | 'accepted' | 'revoked' | 'expired'
expires_atstring date-time required
invitation_tokenstring
token_returned_onceboolean
invited_bystring uuid
accepted_bystring uuid nullable
accepted_atstring date-time nullable
revoked_atstring date-time nullable
created_atstring date-time
updated_atstring date-time

Changes

  • 54aa0701214bRevision changes
    • warning

      added the new facebook enum value to the response property for the response status

    • warning

      added the new linkedin enum value to the response property for the response status

    • warning

      added the new microsoft enum value to the response property for the response status

    • info

      added the new facebook enum value to the request property

    • info

      added the new linkedin enum value to the request property

    • info

      added the new microsoft enum value to the request property

  • 05b67deceeacRevision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • info

      the endpoint scheme security controlBearer was added to the API

    • info

      the endpoint scheme security controlCookie was added to the API

    • info

      the endpoint scheme security operatorBearer was removed from the API

    • info

      the endpoint scheme security operatorCookie was removed from the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the media type application/json for the response with the status