/v1/mgmt/connector/template/allAuthorization
Descope Project ID and Management Key Project ID:Management Key as bearer token.
In: header
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.
curl -X GET "https://api.descope.com/v1/mgmt/connector/template/all"{ "templates": [ { "id": "string", "name": "string", "description": "string", "categories": [ "string" ], "types": [ "string" ], "requiredLicense": "string", "fields": [ { "name": "string", "displayName": "string", "description": "string", "type": "string", "required": true, "defaultValue": null, "options": [ { "value": "string", "name": "string", "description": "string" } ], "dependsOn": { "name": "string", "values": [ null ] }, "format": "string", "secret": true } ] } ]}export interface Response {/** * The available templates, without their fields. */templates?: {/** * The template id, which is the `type` of the connectors created from it, such as `http`. */id?: string/** * The template's display name, such as `HTTP`. */name?: string/** * What the connector does. */description?: string/** * Categories for browsing templates, such as `Observability`. */categories?: string[]/** * Where connectors made from this template can be used: `flows`, `messaging` or `audit`. */types?: string[]/** * The company license this template needs, or empty when it needs none. */requiredLicense?: string/** * The configuration fields, in display order. Only returned by GetConnectorTemplate. */fields?: ConnectorTemplateField[]}[]}export interface ConnectorTemplateField {/** * The field's key in the connector's `configuration`. */name?: string/** * The field's display name. */displayName?: string/** * What the field is for and how to get its value. */description?: string/** * The value's type: `string`, `number` and `boolean` are plain values; `secret`, `secret-file` and `secret-json-file` * are secret strings; `secret-object` is a list of `{key, value, secret}` entries, where the values of entries with * `secret: true` are stored encrypted and returned as `PLACEHOLDER_VALUE`; `httpAuth` is an authentication object * with `method` and that method's settings, see GetConnectorTemplate, whose secret values (API key token, basic * password, bearer token, OAuth client secret) are likewise returned as `PLACEHOLDER_VALUE` and kept when sent back; * `readonly-string` is generated by Descope on create, returned in the connector's `configuration`, and * may only be sent back unchanged; `cloudformation-link` is a console link to an AWS CloudFormation stack, not a * value, and is never sent; other types such as `auditFilters` are objects specific to the template. */type?: string/** * Whether a value is required when the field applies, see `dependsOn`. A missing field with a `defaultValue` is * filled in. */required?: boolean/** * The value filled in when the field is missing on create or update, if any. */defaultValue?: {[k: string]: unknown}/** * The allowed values, when the field has a fixed set of them. */options?: ConnectorTemplateFieldOption[]/** * When set, the field applies only when another field has one of the given values. */dependsOn?: ConnectorTemplateFieldDependsOn/** * A format the value must have, such as `email` or `url`, or empty. */format?: string/** * Whether the field holds secrets, which are stored encrypted and returned as `PLACEHOLDER_VALUE`: the whole value * for `secret`, `secret-file` and `secret-json-file`, and the values of entries with `secret: true` for * `secret-object`. Fields of type `httpAuth` also hold secrets inside their value, see `type`. */secret?: boolean}export interface ConnectorTemplateFieldOption {/** * The value to set. */value?: string/** * The option's display name. */name?: string/** * What the option means. */description?: string}export interface ConnectorTemplateFieldDependsOn {/** * The name of the field this field depends on. */name?: string/** * The values of that field for which this field applies. */values?: {[k: string]: unknown}[]}Get connector GET
Get a single connector by id, using a valid management key, with its configuration. Secret values are returned as `PLACEHOLDER_VALUE`.
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.