API reference

Invite

Management API contract View .md

POST/v1/institutions/{institution_id}/invitations

Authentication Bearer access token with audience taifa-management. Roles and local eligibility are reviewed separately from the OpenAPI bearer scheme.

Parameters

Name	In	Type	Required	Description
`institution_id`	path	`string`	Yes
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredInvitationCreate

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500
`recipient`	`string`	Yes	Validation: min length 3; max length 254
`expires_in_hours`	`integer`	No	Validation: minimum 1; maximum 168

Responses

201Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request example

Illustrative only. TypeScript runs in Node.js on the server. Keep management tokens out of browser bundles. Replace the host, token, path values, and any header or required body placeholders before use. Examples do not send requests.

curl -X POST 'https://YOUR_IDENTITY_HOST/v1/institutions/REPLACE_WITH_INSTITUTION_ID/invitations' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'idempotency-key: REPLACE_WITH_IDEMPOTENCY_KEY' \
  -H 'Content-Type: application/json' \
  --data '{
  "reason": "REPLACE_WITH_REASON",
  "recipient": "REPLACE_WITH_RECIPIENT"
}'

Response example

No response example in the current specification.

All workflows operations