Sign in

v1

latestOpenAPI 3.0.42026-08-064075233.0 KB
Credentials

Create a new credential

Creates a new credential for the specified organization.

post/api/credentials

Request body

namestring nullable

Name of the credential.

organizationIdstring uuid

Unique identifier for the organization that owns the credential.

categorystring nullable

Category of the credential.

datastring byte nullable

Data of the credential in base64 encoded format.

descriptionstring nullable

Description of the credential.

typestring nullable

Type of the credential.

Example request

{
  "name": "My credential",
  "organizationId": "b8fd973c-b700-4091-bf83-e5d779ce7ef0",
  "category": "/organization/",
  "data": "eyJhcGlLZXkiOiJNeSBzZWNyZXQga2V5In0=",
  "description": "Credential that does something",
  "type": "API-key"
}

Response

OK

idstring uuid

Unique identifier for the credential.

namestring nullable

Name of the credential.

descriptionstring nullable

Description of the credential.

datastring byte nullable

Data of the credential in base64 encoded format.

encryptionKeyIdstring uuid nullable

Optional. Identifier for the encryption key used to encrypt the credential data.

typestring nullable

Type of the credential.

typeNamestring nullable

Human readable name of the credential type.

organizationIdstring uuid

Unique identifier for the organization that owns the credential.

createdAtstring date-time

Timestamp of when the credential was created.

createdBystring uuid

Unique identifier for the user that created the credential.

updatedAtstring date-time

Timestamp of when the credential was last updated.

updatedBystring uuid

Unique identifier for the user that last updated the credential.

nrOfFlowDefinitionsinteger

Number of flow definitions using this credential.

categorystring nullable

Category of the credential.

Example response

{
  "id": "7fd96b83-4375-4fb8-af1c-7e5f5117cfc2",
  "name": "My credential",
  "description": "Credential that does something",
  "data": "eyJhcGlLZXkiOiJNeSBzZWNyZXQga2V5In0=",
  "type": "API-key",
  "typeName": "API Key",
  "organizationId": "b8fd973c-b700-4091-bf83-e5d779ce7ef0",
  "createdAt": "2025-09-24T09:33:38.013347Z",
  "createdBy": "256f791c-fbc0-4435-9429-d291227f6577",
  "updatedAt": "2025-09-24T09:33:38.013347Z",
  "updatedBy": "256f791c-fbc0-4435-9429-d291227f6577",
  "nrOfFlowDefinitions": 5,
  "category": "/organization/"
}