Skip to content

Accept the authenticated manager's own branch invitation

POST
/branch/manager-invitations/accept
curl --request POST \
--url https://example.com/branch/manager-invitations/accept \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: example' \
--data '{ "expectedOnboardingRevision": 1 }'
Idempotency-Key
required
string
>= 1 characters <= 255 characters /^\S(?:.*\S)?$/
Media typeapplication/json
AcceptOwnBranchManagerInvitationRequest
object
expectedOnboardingRevision
required
integer
>= 1
key
additional properties

Exact replay returns the immutable activation result

Media typeapplication/json
object
activationId
required
string format: uuid
/^(?!00000000-0000-0000-0000-000000000000$)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
invitationId
required
string format: uuid
/^(?!00000000-0000-0000-0000-000000000000$)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
memberProfileId
required
string format: uuid
/^(?!00000000-0000-0000-0000-000000000000$)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
branchMembershipId
required
string format: uuid
/^(?!00000000-0000-0000-0000-000000000000$)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
branchId
required
string format: uuid
/^(?!00000000-0000-0000-0000-000000000000$)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
acceptedOnboardingRevision
required
integer
>= 1
relationshipOutboxMessageId
required
integer
>= 1
authorizationRelationshipStatus
required
string
Allowed values: pending
acceptedAt
required
string format: date-time
idempotentReplay
required
boolean
idempotentReplay
required

Invitation accepted, active branch membership committed, and SpiceDB relationship touch outbox queued; permission delivery is not yet confirmed

Media typeapplication/json
object
activationId
required
string format: uuid
/^(?!00000000-0000-0000-0000-000000000000$)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
invitationId
required
string format: uuid
/^(?!00000000-0000-0000-0000-000000000000$)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
memberProfileId
required
string format: uuid
/^(?!00000000-0000-0000-0000-000000000000$)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
branchMembershipId
required
string format: uuid
/^(?!00000000-0000-0000-0000-000000000000$)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
branchId
required
string format: uuid
/^(?!00000000-0000-0000-0000-000000000000$)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
acceptedOnboardingRevision
required
integer
>= 1
relationshipOutboxMessageId
required
integer
>= 1
authorizationRelationshipStatus
required
string
Allowed values: pending
acceptedAt
required
string format: date-time
idempotentReplay
required
boolean
idempotentReplay
required

Bearer access token is required

Media typeapplication/json
One of:
object
status
required
Allowed value: 401
code
required
Allowed value: authentication_required
message
required
string
>= 1 characters /\S/
retryable
required
key
additional properties

Authenticated subject has no invitation it may activate

Media typeapplication/json
One of:
object
status
required
Allowed value: 401
code
required
Allowed value: authentication_required
message
required
string
>= 1 characters /\S/
retryable
required
key
additional properties

Onboarding revision or activation authority conflicts

Media typeapplication/json
One of:
object
status
required
Allowed value: 401
code
required
Allowed value: authentication_required
message
required
string
>= 1 characters /\S/
retryable
required
key
additional properties

Revision, idempotency key, or request shape is invalid

Media typeapplication/json
One of:
object
status
required
Allowed value: 401
code
required
Allowed value: authentication_required
message
required
string
>= 1 characters /\S/
retryable
required
key
additional properties

Activation authority cannot prove a safe result

Media typeapplication/json
One of:
object
status
required
Allowed value: 401
code
required
Allowed value: authentication_required
message
required
string
>= 1 characters /\S/
retryable
required
key
additional properties