Taifa Identity. Docs
OpenAPI Developers

API reference

Reviewed project clients

Management API contract View .md

8 management API operations for Reviewed project clients.

GET/v1/projects/{project_id}/permission-catalogs

List reviewed permission catalogs

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

Parameters

NameInTypeRequiredDescription
project_idpathstringYes

Request body

This operation has no request body.

Responses

200Successful Response

Content type: application/jsonCatalogList

FieldTypeRequiredDescription
catalogsCatalogRead[]Yes
_actionscatalog-propose[]Yes

Other responses

StatusDescriptionSchema
403Current project authority or independent review required
409Current exact proposal, catalog, version or idempotency conflict
413Exact JSON request exceeds 64 KiB
422Invalid exact reviewed policy or registration
503Configured owned issuer authority unavailable

POST/v1/projects/{project_id}/permission-catalogs

Propose an immutable permission catalog

Current project owner proposes a versioned catalog. A separate current platform project approver must approve it. Idempotency-Key replays the exact actor and body.

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

Parameters

NameInTypeRequiredDescription
project_idpathstringYes
idempotency-keyheaderstringYes

Request body

application/jsonRequiredCatalogProposal

FieldTypeRequiredDescription
reasonstringYesValidation: min length 8; max length 500
permissionsPermission[]YesValidation: min items 1; max items 32

Responses

201Successful Response

Content type: application/jsonCatalogRead

FieldTypeRequiredDescription
idstringYes
project_idstringYes
revisionintegerYes
permissionsPermission[]Yes
digeststringYes
statuspending_review | approved | superseded | revokedYes
proposerstringYes
approverstring | nullYes
created_atstringYes
expires_atstringYes
actions(approve | revoke)[]Yes
revocationsRevocationRead[]No

Other responses

StatusDescriptionSchema
403Current project authority or independent review required
409Current exact proposal, catalog, version or idempotency conflict
413Exact JSON request exceeds 64 KiB
422Invalid exact reviewed policy or registration
503Configured owned issuer authority unavailable

POST/v1/projects/{project_id}/permission-catalogs/{catalog_id}/approve

Independently approve a catalog

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

Parameters

NameInTypeRequiredDescription
project_idpathstringYes
catalog_idpathstringYes
idempotency-keyheaderstringYes

Request body

application/jsonRequiredidentity__owned_client_router__Reason

FieldTypeRequiredDescription
reasonstringYesValidation: min length 8; max length 500

Responses

200Successful Response

Content type: application/jsonCatalogRead

FieldTypeRequiredDescription
idstringYes
project_idstringYes
revisionintegerYes
permissionsPermission[]Yes
digeststringYes
statuspending_review | approved | superseded | revokedYes
proposerstringYes
approverstring | nullYes
created_atstringYes
expires_atstringYes
actions(approve | revoke)[]Yes
revocationsRevocationRead[]No

Other responses

StatusDescriptionSchema
403Current project authority or independent review required
409Current exact proposal, catalog, version or idempotency conflict
413Exact JSON request exceeds 64 KiB
422Invalid exact reviewed policy or registration
503Configured owned issuer authority unavailable

POST/v1/projects/{project_id}/permission-catalogs/{catalog_id}/revoke

Revoke an approved catalog

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

Parameters

NameInTypeRequiredDescription
project_idpathstringYes
catalog_idpathstringYes
idempotency-keyheaderstringYes

Request body

application/jsonRequiredidentity__owned_client_router__Reason

FieldTypeRequiredDescription
reasonstringYesValidation: min length 8; max length 500

Responses

200Successful Response

Content type: application/jsonCatalogRead

FieldTypeRequiredDescription
idstringYes
project_idstringYes
revisionintegerYes
permissionsPermission[]Yes
digeststringYes
statuspending_review | approved | superseded | revokedYes
proposerstringYes
approverstring | nullYes
created_atstringYes
expires_atstringYes
actions(approve | revoke)[]Yes
revocationsRevocationRead[]No

Other responses

StatusDescriptionSchema
403Current project authority or independent review required
409Current exact proposal, catalog, version or idempotency conflict
413Exact JSON request exceeds 64 KiB
422Invalid exact reviewed policy or registration
503Configured owned issuer authority unavailable

GET/v1/projects/{project_id}/owned-clients

List reviewed owned-client proposals

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

Parameters

NameInTypeRequiredDescription
project_idpathstringYes

Request body

This operation has no request body.

Responses

200Successful Response

Content type: application/jsonClientList

FieldTypeRequiredDescription
clientsClientRead[]Yes
_actionsclient-propose[]Yes

Other responses

StatusDescriptionSchema
403Current project authority or independent review required
409Current exact proposal, catalog, version or idempotency conflict
413Exact JSON request exceeds 64 KiB
422Invalid exact reviewed policy or registration
503Configured owned issuer authority unavailable

POST/v1/projects/{project_id}/owned-clients

Propose an exact owned-client registration policy

Requires a controlled credential preparation and fresh private issuer custody readback. Stores the full immutable registration and versioned digest with exact accepted owner and catalog evidence for independent review. Approval does not install a client or authorize an assignment. Idempotency-Key replays the exact actor and body after current authority and fresh custody checks.

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

Parameters

NameInTypeRequiredDescription
project_idpathstringYes
idempotency-keyheaderstringYes

Request body

application/jsonRequiredClientProposal

FieldTypeRequiredDescription
reasonstringYesValidation: min length 8; max length 500
target_issuerstringYesValidation: min length 1; max length 2048
client_idstringYesValidation: min length 1; max length 128
client_versionintegerYesValidation: minimum 1; maximum 9223372036854775807
display_namestringYesValidation: min length 3; max length 120
catalog_idstringYesValidation: min length 1; max length 200
credential_preparation_idstringYesCanonical preparation UUID from controlled credential delivery. Management verifies fresh private issuer readback; browser proof is reference metadata only. Validation: min length 36; max length 36
permission_idsstring[]YesValidation: min items 1; max items 32
registrationRegistrationProposalYes

Responses

201Successful Response

Content type: application/jsonClientRead

FieldTypeRequiredDescription
idstringYes
project_idstringYes
target_issuerstringYes
client_idstringYes
client_versionintegerYes
generationintegerYes
display_namestringYes
catalog_idstringYes
catalog_digeststringYes
permission_idsstring[]Yes
registrationRegistrationReadYes
registration_digeststringYes
policy_digeststringYes
credential_preparation_idstring | nullNo
custody_binding_digeststring | nullNo
statuspending_review | approved_pending_readback | superseded | revokedYes
proposerstringYes
approverstring | nullYes
created_atstringYes
expires_atstringYes
actions(approve | revoke)[]Yes
revocationRevocationRead | nullNo

Other responses

StatusDescriptionSchema
403Current project authority or independent review required
409Current exact proposal, catalog, version or idempotency conflict
413Exact JSON request exceeds 64 KiB
422Invalid exact reviewed policy or registration
503Configured owned issuer authority unavailable

POST/v1/projects/{project_id}/owned-clients/{policy_id}/approve

Independently approve an owned-client proposal

Obtains fresh private custody readback before source locks and records an independent current approver with the exact proposal and approved catalog evidence. The approved_pending_readback state still requires separate reviewed installation and product acknowledgement.

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

Parameters

NameInTypeRequiredDescription
project_idpathstringYes
policy_idpathstringYes
idempotency-keyheaderstringYes

Request body

application/jsonRequiredidentity__owned_client_router__Reason

FieldTypeRequiredDescription
reasonstringYesValidation: min length 8; max length 500

Responses

200Successful Response

Content type: application/jsonClientRead

FieldTypeRequiredDescription
idstringYes
project_idstringYes
target_issuerstringYes
client_idstringYes
client_versionintegerYes
generationintegerYes
display_namestringYes
catalog_idstringYes
catalog_digeststringYes
permission_idsstring[]Yes
registrationRegistrationReadYes
registration_digeststringYes
policy_digeststringYes
credential_preparation_idstring | nullNo
custody_binding_digeststring | nullNo
statuspending_review | approved_pending_readback | superseded | revokedYes
proposerstringYes
approverstring | nullYes
created_atstringYes
expires_atstringYes
actions(approve | revoke)[]Yes
revocationRevocationRead | nullNo

Other responses

StatusDescriptionSchema
403Current project authority or independent review required
409Current exact proposal, catalog, version or idempotency conflict
413Exact JSON request exceeds 64 KiB
422Invalid exact reviewed policy or registration
503Configured owned issuer authority unavailable

POST/v1/projects/{project_id}/owned-clients/{policy_id}/revoke

Revoke an owned-client proposal

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

Parameters

NameInTypeRequiredDescription
project_idpathstringYes
policy_idpathstringYes
idempotency-keyheaderstringYes

Request body

application/jsonRequiredidentity__owned_client_router__Reason

FieldTypeRequiredDescription
reasonstringYesValidation: min length 8; max length 500

Responses

200Successful Response

Content type: application/jsonClientRead

FieldTypeRequiredDescription
idstringYes
project_idstringYes
target_issuerstringYes
client_idstringYes
client_versionintegerYes
generationintegerYes
display_namestringYes
catalog_idstringYes
catalog_digeststringYes
permission_idsstring[]Yes
registrationRegistrationReadYes
registration_digeststringYes
policy_digeststringYes
credential_preparation_idstring | nullNo
custody_binding_digeststring | nullNo
statuspending_review | approved_pending_readback | superseded | revokedYes
proposerstringYes
approverstring | nullYes
created_atstringYes
expires_atstringYes
actions(approve | revoke)[]Yes
revocationRevocationRead | nullNo

Other responses

StatusDescriptionSchema
403Current project authority or independent review required
409Current exact proposal, catalog, version or idempotency conflict
413Exact JSON request exceeds 64 KiB
422Invalid exact reviewed policy or registration
503Configured owned issuer authority unavailable

Popular

Browse by section