Embedded APIResourcesAPI platform

Create API client (v2)

Creates a new API client in a specified project 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.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
namestringRequired
Name of the client.
api_collection_idslist of integersRequired
IDs of API collections to assign to the client.
auth_typeenumRequired

Authentication method to validate requests. Supported types: token, jwt, oauth2, oidc.

Allowed values:
descriptionstringOptional
Description of the client.
project_idintegerOptional
ID of the project where you plan to create the client.
api_portal_idintegerOptional

The ID of the API portal to assign the client, required when email is provided.

emailstringOptional

Email address for the client, required if api_portal_id exists.

api_policy_idintegerOptional
ID of the API policy to apply.
jwt_methodenumOptional

The JWT signing method, required when auth_type is jwt. Supported methods: hmac, rsa.

Allowed values:
jwt_secretstringOptional

HMAC shared secret or RSA public key, required when auth_type is jwt.

oidc_issuerstringOptional

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

oidc_jwks_uristringOptional

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

access_profile_claimstringOptional

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

required_claimslist of stringsOptional

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

allowed_issuerslist of stringsOptional

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 created successfully.

dataobject or null

Errors