/v1/mgmt/connectorAuthorization
Descope Project ID and Management Key Project ID:Management Key as bearer token.
In: header
Query Parameters
Required. The connector id, as CreateConnector and LoadAllConnectors return it; ids starting with MP are
messaging providers.
Get a single connector by id, using a valid management key, with its configuration. Secret values are returned as PLACEHOLDER_VALUE.
curl -X GET "https://api.descope.com/v1/mgmt/connector?id=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?: {}}Get connector template GET
Get one connector template by id, using a valid management key, with its configuration fields: each field's name, type, whether it is required, its default value, its allowed values, the field it depends on, and its documentation. Build the `configuration` for CreateConnector from these fields; the server checks it against them. Secret values come from the user: don't invent them unless the user asks for a placeholder. An `httpAuth` value is an object with `method` and that method's settings: `none`; `bearerToken` with `bearerToken`; `apiKey` with `apiKey: {key, token}`; `basic` with `basic: {username, password}`; `oauth2ClientCredentials` with `oauth2ClientCredentials: {clientId, clientSecret, authUrl, authStyle}`, all required, where `authStyle` is `body` or `header` with no default, plus optional `scopes` as one space-separated string. A `secret-object` value is a list of `{key, value, secret}` entries; `secret` defaults to false, and a secret entry is read back as `PLACEHOLDER_VALUE` with `secret: true`. Leave out fields of type `cloudformation-link`, a console-only link, and `readonly-string`, which Descope generates on create and cannot be changed; give the generated value from the returned connector to the user, such as an AWS external ID to put in the IAM role's trust policy. Returns not found for unknown templates.
Load all connector templates GET
Load the connector templates the project can create connectors from, using a valid management key. Each template's `id` is the `type` to pass to CreateConnector, and `name` is its display name. Templates are returned without their fields; call GetConnectorTemplate for one template's configuration fields before creating a connector. Internal and early-release templates are not listed, and a template with a `requiredLicense` is listed only when the company has that license. Messaging providers such as `sendgrid` have no template and are not listed. SSO and social login (OAuth) providers are not connectors; they have their own operations.