Credentials

Create

organizations.service_accounts.credentials.create(, ) -> CredentialCreateResponse

POST/organizations/{organization_id}/service-accounts/{service_account_id}/credentials

Create a new credential for a service account

ParametersExpand Collapse

organization_id: str

Organization ID or label identifier

minLength1

maxLength255

service_account_id: str

Identifier for API resources. A 26-char nanoid (URL/DNS safe).

minLength1

maxLength255

name: str

Credential name

description: Optional[str]

Optional description of the credential

maxLength500

x_client_request_id: Optional[str]

formatuuid

ReturnsExpand Collapse

class CredentialCreateResponse: …

Service account credential with plaintext secret (only returned on creation)

id: str

Identifier for API resources. A 26-char nanoid (URL/DNS safe).

minLength1

maxLength255

client_id: str

The client ID for authentication

client_secret: str

The client secret

created_at: datetime

The time the entity was created in utc

formatdate-time

name: str

A name for the entity to be displayed in UI

description: Optional[str]

Optional description of the credential

Create

from keycardai_api import KeycardAPI

client = KeycardAPI()
credential = client.organizations.service_accounts.credentials.create(
    service_account_id="ab3def8hij2klm9opq5rst7uvw",
    organization_id="x",
    name="name",
)
print(credential.id)

{
  "id": "ab3def8hij2klm9opq5rst7uvw",
  "client_id": "A1b2C3d4E5f6G7h8I9j0K",
  "client_secret": "a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6q7R8s9T0u1V2w3X4y5Z6A7B8c9D0e1F2",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "description": "description"
}

Returns Examples

{
  "id": "ab3def8hij2klm9opq5rst7uvw",
  "client_id": "A1b2C3d4E5f6G7h8I9j0K",
  "client_secret": "a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6q7R8s9T0u1V2w3X4y5Z6A7B8c9D0e1F2",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "description": "description"
}