Skip to navigation

Create approval integration

View as Markdown

Creates a approval integration and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
connector_idstringRequiredformat: "uuid">=1 character

The connector these approval settings apply to. Only one configuration can exist per connector, and it cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

versionobjectRequired
Document version. On update, send back the num from your last read.
default_resourceobjectOptional

Default approval settings for all resource types from this connector. Resource-specific settings take precedence.

Response

The created approval integration
idstringOptionalRead-only
Unique identifier of this configuration, assigned by the server.
connector_idstringOptionalformat: "uuid">=1 character

The connector these approval settings apply to. Only one configuration can exist per connector, and it cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

default_resourceobjectOptional

Default approval settings for all resource types from this connector. Resource-specific settings take precedence.

updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error