Identity Credentials

Identity credentials bind an identity to concrete provider deployment, config, and auth resources.

Identity Credentials object

Attributes

object

String

String representing the object's type

id

String

Unique identity credential identifier.

status

Enum

Current lifecycle status of the credential.

identity_id

String

Identity that owns this credential.

provider_id

String

Provider associated with the credential.

deployment_id

StringNullable

Provider deployment used by this credential.

config_id

StringNullable

Provider config used by this credential.

auth_config_id

StringNullable

Provider auth config used by this credential.

delegation_config_id

StringNullable

Delegation config applied to this credential.

created_at

Date

Timestamp when the credential was created.

updated_at

Date

Timestamp when the credential was last updated.

{
  "object": "identity.credential",
  "id": "icr_8vBnM4xZa2cDf7gH",
  "status": "active",
  "identity_id": "idn_5gHjKlMnPqRsTuVw",
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "deployment_id": "pdp_4dEfGhJkLmNpQrSt",
  "config_id": "pcf_7dEfGhJkLmNpQrSt",
  "auth_config_id": "pac_3nOpRsTuVwXyZaBc",
  "delegation_config_id": "idc_2mNpQrStUvWxYzAb",
  "created_at": "2026-02-03T10:15:00.000Z",
  "updated_at": "2026-02-10T14:30:00.000Z"
}

List identity credentials

Returns a paginated list of identity credentials for the instance.

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

status

UnionOptional

Filter by one or more credential statuses.

id

UnionOptional

Filter by identity credential ID or IDs.

agent_id

UnionOptional

Filter by owner agent ID or IDs.

actor_id

UnionOptional

Filter by owner actor ID or IDs.

identity_id

UnionOptional

Filter by identity ID or IDs.

provider_id

UnionOptional

Filter by provider ID or IDs.

provider_deployment_id

UnionOptional

Filter by provider deployment ID or IDs.

provider_config_id

UnionOptional

Filter by provider config ID or IDs.

provider_auth_config_id

UnionOptional

Filter by provider auth config ID or IDs.

created_at

ObjectOptional

Filter identity credential creation time by date range

updated_at

ObjectOptional

Filter identity credential last update time by date range

GEThttp://api.metorial.com/identity-credentials
curl -X GET "https://api.metorial.com/identity-credentials" \
  -H "Authorization: Bearer metorial_sk_..."

Get identity credential

Retrieves a specific identity credential by ID.

URL Parameters

identity_credential_id

String

The unique identifier for the identity_credential

GEThttp://api.metorial.com/identity-credentials/:identity_credential_id
curl -X GET "https://api.metorial.com/identity-credentials/ide_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Create identity credential

Creates a new credential and attaches it to an identity.

Request Body

identity_id

String

Identity that will own the new credential.

deployment_id

StringOptional

Provider deployment to attach to the credential.

config_id

StringOptional

Provider config to attach to the credential.

auth_config_id

StringOptional

Provider auth config to attach to the credential.

delegation_config_id

StringOptional

Delegation config to apply to the credential.

POSThttp://api.metorial.com/identity-credentials
curl -X POST "https://api.metorial.com/identity-credentials" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "identity_id": "example_identity_id",
  "deployment_id": "example_deployment_id",
  "config_id": "example_config_id",
  "auth_config_id": "example_auth_config_id",
  "delegation_config_id": "example_delegation_config_id"
}'

Update identity credential

Updates the delegation config attached to an identity credential.

URL Parameters

identity_credential_id

String

The unique identifier for the identity_credential

Request Body

delegation_config_id

String

Delegation config to apply to the credential.

PATCHhttp://api.metorial.com/identity-credentials/:identity_credential_id
curl -X PATCH "https://api.metorial.com/identity-credentials/ide_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "delegation_config_id": "example_delegation_config_id"
}'

Delete identity credential

Archives an identity credential.

URL Parameters

identity_credential_id

String

The unique identifier for the identity_credential

DELETEhttp://api.metorial.com/identity-credentials/:identity_credential_id
curl -X DELETE "https://api.metorial.com/identity-credentials/ide_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."