Skip to content

Credentials

Create Credential
client.credentials.create(CredentialCreateParams { name, payload, type, 2 more } body, RequestOptionsoptions?): Credential { id, created_at, created_by_identity_type, 7 more }
POST/v5/credentials
Get Credential by ID
client.credentials.retrieve(stringcredentialID, RequestOptionsoptions?): Credential { id, created_at, created_by_identity_type, 7 more }
GET/v5/credentials/{credential_id}
Get Credential by Name
client.credentials.retrieveByName(stringcredentialName, RequestOptionsoptions?): Credential { id, created_at, created_by_identity_type, 7 more }
GET/v5/credentials/name/{credential_name}
Get Credential Secret by ID
client.credentials.decrypt(stringcredentialID, RequestOptionsoptions?): CredentialSecret { result, object }
POST/v5/credentials/{credential_id}/secret
Get Credential Secret by Name
client.credentials.decryptByName(stringcredentialName, RequestOptionsoptions?): CredentialSecret { result, object }
POST/v5/credentials/name/{credential_name}/secret
List Credentials
client.credentials.list(CredentialListParams { ending_before, limit, name, 3 more } query?, RequestOptionsoptions?): CursorPage<Credential { id, created_at, created_by_identity_type, 7 more } >
GET/v5/credentials
Update Credential
client.credentials.update(stringcredentialID, CredentialUpdateParams { credential_metadata, description, name, 2 more } body, RequestOptionsoptions?): Credential { id, created_at, created_by_identity_type, 7 more }
PATCH/v5/credentials/{credential_id}
Delete Credential
client.credentials.delete(stringcredentialID, RequestOptionsoptions?): CredentialDeleteResponse { id, deleted, object }
DELETE/v5/credentials/{credential_id}
ModelsExpand Collapse
Credential { id, created_at, created_by_identity_type, 7 more }
id: string
created_at: string
formatdate-time
created_by_identity_type: string | null
created_by_user_id: string | null
credential_metadata: Record<string, unknown> | null
description: string | null
name: string
type: string
updated_at: string
formatdate-time
object?: string
CredentialSecret { result, object }
result: string
object?: string
CredentialDeleteResponse { id, deleted, object }
id: string
deleted: boolean
object?: string