Skip to main content

Create access definition

Create a new access definition for an organization.

Header Parameters
organization-id uuid

ID of organization context this request belongs to.

Request Body REQUIRED
accessExchangeType string REQUIRED

Possible values: [GENERATE_TOKEN, MANUAL_EXCHANGE]

accessType object
hashAlgorithm string REQUIRED

Possible values: Value must match regular expression SHA256

maxTokenLength int32 REQUIRED

Possible values: 32 ≤ value ≤ 128

type string REQUIRED

Possible values: Value must match regular expression accessToken

validityPeriod int32 REQUIRED

Runtime of the access token in days. Set to zero for unlimited validity.

active boolean
defaultDefinition boolean
name string REQUIRED

Possible values: 3 ≤ length ≤ 255

providerId uuid REQUIRED
Responses
201

Access definition successfully created

Schema OPTIONAL
accessExchangeType string OPTIONAL

Possible values: [GENERATE_TOKEN, MANUAL_EXCHANGE]

Defines the type of exchange for generated credentials.

accessType object OPTIONAL

Defines the way in which the credentials for the access are generated.

hashAlgorithm string OPTIONAL
maxTokenLength int32 OPTIONAL

Maximum length of the access token

validityPeriod int32 OPTIONAL

Runtime of the access token in days, unlimited when empty.

type string OPTIONAL
active boolean OPTIONAL
defaultDefinition boolean OPTIONAL
id uuid OPTIONAL
name string OPTIONAL
400

Bad Request (e.g. element not found or resource conflict).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
403

Missing permission

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
500

Internal server error (Internal service communication or process error).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL