/v1/mgmt/connectorAuthorization
Descope Project ID and Management Key Project ID:Management Key as bearer token.
In: header
Request Body
application/json
The connector id, assigned by the server on create and required on update.
length <= 254The connector's display name.
1 <= length <= 254The connector template id, such as http, which cannot change after create. LoadAllConnectorTemplates lists the
available templates.
1 <= length <= 254Either enabled or disabled, defaults to enabled on create. A disabled connector is not run by flows or
automatic triggers; audit streaming ignores status and follows the template's auditEnabled configuration field
if it has one, and is otherwise always on. While its secrets are placeholders, create a connector disabled, also
set auditEnabled: false on an audit connector whose template has that field, and enable it once the real values
are in.
A free text description of the connector.
length <= 254The template's configuration fields by name, as GetConnectorTemplate describes them. Checked against the template
on create and update, with missing defaults filled in; not checked for messaging providers, which have no template.
Secret values are returned as PLACEHOLDER_VALUE, and sending that value back keeps the stored secret.
Update a single connector, using a valid management key. This is a full replace, not a patch: get the connector first with GetConnector and send every field back with your changes, including name, description and the full configuration. Send PLACEHOLDER_VALUE to keep a stored secret; an omitted key is cleared, or reset to its default when it has one, and omitting a required secret fails validation. The type cannot change. The configuration is checked and filled as on create, except for messaging providers (ids starting with MP).
curl -X PUT "https://api.descope.com/v1/mgmt/connector" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "type": "string" }'{ "id": "string", "name": "string", "type": "string", "status": "string", "description": "string", "configuration": {}}export interface Response {/** * The connector id, assigned by the server on create and required on update. */id?: string/** * The connector's display name. */name: string/** * The connector template id, such as `http`, which cannot change after create. LoadAllConnectorTemplates lists the * available templates. */type: string/** * Either `enabled` or `disabled`, defaults to `enabled` on create. A disabled connector is not run by flows or * automatic triggers; audit streaming ignores `status` and follows the template's `auditEnabled` configuration field * if it has one, and is otherwise always on. While its secrets are placeholders, create a connector `disabled`, also * set `auditEnabled: false` on an audit connector whose template has that field, and enable it once the real values * are in. */status?: string/** * A free text description of the connector. */description?: string/** * The template's configuration fields by name, as GetConnectorTemplate describes them. Checked against the template * on create and update, with missing defaults filled in; not checked for messaging providers, which have no template. * Secret values are returned as `PLACEHOLDER_VALUE`, and sending that value back keeps the stored secret. */configuration?: {}}Load all connectors GET
Load all of the project's connectors, using a valid management key. Each connector is returned as GetConnector returns it, with its configuration and with secret values as `PLACEHOLDER_VALUE`. This includes messaging provider connectors, whose ids start with `MP`, and leaves out connectors that Descope manages internally, such as outbound SCIM connectors, as the console does.
Create dynamic registration template POST
Create a new dynamic registration template, using a valid management key.