Embedded APIResourcesAPI platform

Update API client

Update an existing API client within a project you specify in a customer workspace.

Path parameters

idstringRequired

Embedded customer ID (external ID). The External ID must be URL encoded and prefixed with an E. For example, EA2300.

api_client_idstringRequired
The unique identifier of the API client to update.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired
Updated name of the client.
api_collection_idslist of integersRequired
Updated list of API collections assigned to the client.
descriptionstringOptional
Updated description of the client.
project_idintegerOptional
Updated project ID associated with the client.
emailstringOptional
Updated email address for the client.
api_policy_idintegerOptional
Updated API policy ID.
jwt_methodenumOptional

Updated JWT signing method. Required when auth_type is jwt. Supported methods: hmac, rsa.

Allowed values:
jwt_secretstringOptional

Updated HMAC shared secret or RSA public key. Required when auth_type is jwt.

oidc_issuerstringOptional

Updated discovery URL for the OIDC identity provider. Specify this or oidc_jwks_uri when auth_type is jwt or oidc.

oidc_jwks_uristringOptional

Updated JWKS URL for the OIDC identity provider. Specify this or oidc_issuer when auth_type is jwt or oidc.

access_profile_claimstringOptional

Updated JWT claim key used to identify the access profile. Applicable when auth_type is jwt or oidc.

required_claimslist of stringsOptional

Updated list of claims to enforce. Applicable when auth_type is jwt or oidc.

allowed_issuerslist of stringsOptional

Updated list of issuers (iss claim) to allow. If the iss claim is enforced in required_claims, leave blank to allow any issuer. Applicable when auth_type is jwt or oidc.

Response

Success - The API client was updated successfully.

dataobject or null

Errors