API reference

Workflows

Management API contract View .md

28 management API operations for workflows.

GET/v1/registration-contextDeployment Context POST/v1/institutions/{institution_id}/administratorsPropose Admin POST/v1/institutions/{institution_id}/administrators/{proposal_id}/approveApprove Admin POST/v1/institutions/{institution_id}/domainsPropose Domain POST/v1/institutions/{institution_id}/domains/{domain_id}/verifyVerify Domain POST/v1/institutions/{institution_id}/sponsorsSponsor Change POST/v1/institutions/{institution_id}/invitationsInvite POST/v1/invitations/{invitation_id}/redeemRedeem POST/v1/institutions/{institution_id}/account-proofsProof POST/v1/link-requestsRequest Link POST/v1/link-requests/{request_id}/approveApprove Link POST/v1/institutions/{institution_id}/recovery-requestsRecovery POST/v1/recovery-requests/{request_id}/approveApprove Recovery POST/v1/projects/{project_id}/ownersOwner POST/v1/projects/{project_id}/environmentsEnvironment GET/v1/projects/{project_id}/environmentsEnvironments POST/v1/projects/{project_id}/environments/{environment_id}/review-existingReview Existing Environment POST/v1/projects/{project_id}/environments/{environment_id}/approveApprove Environment POST/v1/projects/{project_id}/environments/{environment_id}/credential/revealReveal Credential GET/v1/projects/{project_id}/environments/{environment_id}/credentialCredential Status POST/v1/projects/{project_id}/environments/{environment_id}/credential/rotateRotate Credential POST/v1/institutions/{institution_id}/invitations/{invitation_id}/cancelCancel Invitation POST/v1/institutions/{institution_id}/workflow-decisions/{kind}/{record_id}/rejectReject GET/v1/institutions/{institution_id}/workflowsInstitution Workflows GET/v1/institutions/{institution_id}/workflow-evidence/{kind}/{record_id}Workflow Evidence GET/v1/projects/{project_id}/registration-contextRegistration Context GET/v1/projects/{project_id}/native-profilesNative Profiles GET/v1/me/workflowsPersonal Workflows

GET`/v1/registration-context`

Deployment Context

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

Parameters

No path or query parameters declared.

Request body

This operation has no request body.

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Request and response examples

POST`/v1/institutions/{institution_id}/administrators`

Propose Admin

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/jsonRequiredAdministratorCreate

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500
`evidence_reference`	`string`	Yes	Validation: min length 5; max length 500
`person_id`	`string`	Yes

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 and response examples

POST`/v1/institutions/{institution_id}/administrators/{proposal_id}/approve`

Approve Admin

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
`institution_id`	path	`string`	Yes
`proposal_id`	path	`string`	Yes
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredMutation

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

POST`/v1/institutions/{institution_id}/domains`

Propose Domain

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/jsonRequiredDomainCreate

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500
`evidence_reference`	`string`	Yes	Validation: min length 5; max length 500
`domain`	`string`	Yes	Validation: min length 3; max length 253

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 and response examples

POST`/v1/institutions/{institution_id}/domains/{domain_id}/verify`

Verify Domain

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
`institution_id`	path	`string`	Yes
`domain_id`	path	`string`	Yes
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredEvidence

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500
`evidence_reference`	`string`	Yes	Validation: min length 5; max length 500

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

POST`/v1/institutions/{institution_id}/sponsors`

Sponsor Change

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/jsonRequiredSponsorChange

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500
`evidence_reference`	`string`	Yes	Validation: min length 5; max length 500
`person_id`	`string`	Yes
`active`	`boolean`	No

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

POST`/v1/institutions/{institution_id}/invitations`

Invite

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 and response examples

POST`/v1/invitations/{invitation_id}/redeem`

Redeem

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
`invitation_id`	path	`string`	Yes
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredInvitationRedeem

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500
`secret`	`string`	Yes	Validation: min length 32; max length 256

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

POST`/v1/institutions/{institution_id}/account-proofs`

Proof

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/jsonRequiredProofCreate

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500
`evidence_reference`	`string`	Yes	Validation: min length 5; max length 500
`project_id`	`string`	Yes
`person_id`	`string`	Yes
`local_account_id`	`string`	Yes	Validation: min length 1; max length 200
`expires_in_minutes`	`integer`	No	Validation: minimum 1; maximum 60

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 and response examples

POST`/v1/link-requests`

Request Link

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
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredLinkCreate

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500
`proof_id`	`string`	Yes

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 and response examples

POST`/v1/link-requests/{request_id}/approve`

Approve Link

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
`request_id`	path	`string`	Yes
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredMutation

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

POST`/v1/institutions/{institution_id}/recovery-requests`

Recovery

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/jsonRequiredRecoveryCreate

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500
`evidence_reference`	`string`	Yes	Validation: min length 5; max length 500
`person_id`	`string`	Yes

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 and response examples

POST`/v1/recovery-requests/{request_id}/approve`

Approve Recovery

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
`request_id`	path	`string`	Yes
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredMutation

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

POST`/v1/projects/{project_id}/owners`

Owner

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
`project_id`	path	`string`	Yes
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredOwnerChange

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500
`person_id`	`string`	Yes
`active`	`boolean`	No

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

POST`/v1/projects/{project_id}/environments`

Environment

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
`project_id`	path	`string`	Yes
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredEnvironmentCreate

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500
`name`	`string`	Yes	Validation: pattern ^(development\|staging\|production)$
`client_type`	`public \| confidential-web \| native-mail-ios \| native-mail-android \| native-mail-desktop`	No
`redirect_uris`	`string[]`	Yes	Validation: min items 1; max items 20
`scopes`	`string[]`	No	Validation: min items 1; max items 10

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 and response examples

GET`/v1/projects/{project_id}/environments`

Environments

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
`project_id`	path	`string`	Yes

Request body

This operation has no request body.

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

POST`/v1/projects/{project_id}/environments/{environment_id}/review-existing`

Review Existing Environment

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
`project_id`	path	`string`	Yes
`environment_id`	path	`string`	Yes
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredMutation

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

POST`/v1/projects/{project_id}/environments/{environment_id}/approve`

Approve Environment

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
`project_id`	path	`string`	Yes
`environment_id`	path	`string`	Yes
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredMutation

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

POST`/v1/projects/{project_id}/environments/{environment_id}/credential/reveal`

Reveal Credential

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
`project_id`	path	`string`	Yes
`environment_id`	path	`string`	Yes
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredMutation

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

GET`/v1/projects/{project_id}/environments/{environment_id}/credential`

Credential Status

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
`project_id`	path	`string`	Yes
`environment_id`	path	`string`	Yes

Request body

This operation has no request body.

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

POST`/v1/projects/{project_id}/environments/{environment_id}/credential/rotate`

Rotate Credential

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
`project_id`	path	`string`	Yes
`environment_id`	path	`string`	Yes
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredMutation

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

POST`/v1/institutions/{institution_id}/invitations/{invitation_id}/cancel`

Cancel Invitation

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
`institution_id`	path	`string`	Yes
`invitation_id`	path	`string`	Yes
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredMutation

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

POST`/v1/institutions/{institution_id}/workflow-decisions/{kind}/{record_id}/reject`

Reject

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
`institution_id`	path	`string`	Yes
`kind`	path	`administrator \| domain \| link \| recovery \| federation`	Yes
`record_id`	path	`string`	Yes
`idempotency-key`	header	`string`	Yes

Request body

application/jsonRequiredMutation

Field	Type	Required	Description
`reason`	`string`	Yes	Validation: min length 8; max length 500

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

GET`/v1/institutions/{institution_id}/workflows`

Institution Workflows

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

Request body

This operation has no request body.

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

GET`/v1/institutions/{institution_id}/workflow-evidence/{kind}/{record_id}`

Workflow Evidence

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
`institution_id`	path	`string`	Yes
`kind`	path	`administrator \| domain \| federation \| recovery`	Yes
`record_id`	path	`string`	Yes

Request body

This operation has no request body.

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

GET`/v1/projects/{project_id}/registration-context`

Registration Context

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
`project_id`	path	`string`	Yes

Request body

This operation has no request body.

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

GET`/v1/projects/{project_id}/native-profiles`

Native Profiles

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
`project_id`	path	`string`	Yes

Request body

This operation has no request body.

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

Status	Description	Schema
422	Validation Error	`HTTPValidationError`

Request and response examples

GET`/v1/me/workflows`

Personal Workflows

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

Parameters

No path or query parameters declared.

Request body

This operation has no request body.

Responses

200Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Request and response examples

All API resources

GET/v1/registration-context

Parameters

Request body

Responses

200Successful Response

POST/v1/institutions/{institution_id}/administrators

Parameters

Request body

Responses

201Successful Response

Other responses

POST/v1/institutions/{institution_id}/administrators/{proposal_id}/approve

Parameters

Request body

Responses

200Successful Response

Other responses

POST/v1/institutions/{institution_id}/domains

Parameters

Request body

Responses

201Successful Response

Other responses

POST/v1/institutions/{institution_id}/domains/{domain_id}/verify

Parameters

Request body

Responses

200Successful Response

Other responses

POST/v1/institutions/{institution_id}/sponsors

Parameters

Request body

Responses

200Successful Response

Other responses

POST/v1/institutions/{institution_id}/invitations

Parameters

Request body

Responses

201Successful Response

Other responses

POST/v1/invitations/{invitation_id}/redeem

Parameters

Request body

Responses

200Successful Response

Other responses

POST/v1/institutions/{institution_id}/account-proofs

Parameters

Request body

Responses

201Successful Response

Other responses

POST/v1/link-requests

Parameters

Request body

Responses

201Successful Response

Other responses

POST/v1/link-requests/{request_id}/approve

Parameters

Request body

Responses

200Successful Response

Other responses

POST/v1/institutions/{institution_id}/recovery-requests

Parameters

Request body

Responses

201Successful Response

Other responses

POST/v1/recovery-requests/{request_id}/approve

Parameters

Request body

Responses

200Successful Response

Other responses

POST/v1/projects/{project_id}/owners

Parameters

Request body

GET`/v1/registration-context`

POST`/v1/institutions/{institution_id}/administrators`

POST`/v1/institutions/{institution_id}/administrators/{proposal_id}/approve`

POST`/v1/institutions/{institution_id}/domains`

POST`/v1/institutions/{institution_id}/domains/{domain_id}/verify`

POST`/v1/institutions/{institution_id}/sponsors`

POST`/v1/institutions/{institution_id}/invitations`

POST`/v1/invitations/{invitation_id}/redeem`

POST`/v1/institutions/{institution_id}/account-proofs`

POST`/v1/link-requests`

POST`/v1/link-requests/{request_id}/approve`

POST`/v1/institutions/{institution_id}/recovery-requests`

POST`/v1/recovery-requests/{request_id}/approve`

POST`/v1/projects/{project_id}/owners`

POST`/v1/projects/{project_id}/environments`

GET`/v1/projects/{project_id}/environments`

POST`/v1/projects/{project_id}/environments/{environment_id}/review-existing`

POST`/v1/projects/{project_id}/environments/{environment_id}/approve`

POST`/v1/projects/{project_id}/environments/{environment_id}/credential/reveal`

GET`/v1/projects/{project_id}/environments/{environment_id}/credential`

POST`/v1/projects/{project_id}/environments/{environment_id}/credential/rotate`

POST`/v1/institutions/{institution_id}/invitations/{invitation_id}/cancel`

POST`/v1/institutions/{institution_id}/workflow-decisions/{kind}/{record_id}/reject`

GET`/v1/institutions/{institution_id}/workflows`

GET`/v1/institutions/{institution_id}/workflow-evidence/{kind}/{record_id}`