API ReferenceManagementAuth Access Policy Management
PUT
/v1/mgmt/authaccess/rule

Authorization

Descope Project ID and Management Key
AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

id?string

Server-generated, rejected on create and required on update.

Lengthlength <= 254
name?string
Lengthlength <= 254
description?string
Lengthlength <= 100000
enabled?boolean

Defaults to true on create.

effect?string

Required on create. Evaluation is first-match.

conditions?unknown

Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.

createdTime?integer

int32 epoch seconds: proto3 emits int64 as JSON string. See .claude/rules/proto-files.md.

Formatint32
modifiedTime?integer
Formatint32
evaluationOrder?integer

1-based position in the evaluation order, set through the reorder and settings endpoints.

Formatint32
expireTime?integer

Epoch seconds after which the rule is no longer evaluated. 0 means never.

Formatint32

Update a project-level auth access policy rule. Fields that are not sent keep their stored values, using a valid management key.

curl -X PUT "https://api.descope.com/v1/mgmt/authaccess/rule" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "description": "string",  "enabled": true,  "effect": "string",  "conditions": null,  "createdTime": 0,  "modifiedTime": 0,  "evaluationOrder": 0,  "expireTime": 0}
/** * conditions is a list of {key, operator, values} objects, all of which must match. key is one of request.ip, *  request.country, user.email, user.emailDomain, user.loginId and user.phone. operator is one of equal, notEqual, in, *  notIn, inCidr and notInCidr, where equal, notEqual, inCidr and notInCidr take exactly one value. Values must be in *  canonical form: lowercase emails and domains, uppercase countries, E.164 phones and compressed IP addresses. With *  equal and notEqual the value may instead be a reference of the form {{jwtClaims.<name>}}, which compares the *  attribute against the named top-level custom claim of the token the caller presented. An absent claim never *  matches, notEqual included. */export interface Response {/** * Server-generated, rejected on create and required on update. */id?: stringname?: stringdescription?: string/** * Defaults to true on create. */enabled?: boolean/** * Required on create. Evaluation is first-match. */effect?: string/** * Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. */conditions?: {[k: string]: unknown}/** * int32 epoch seconds: proto3 emits int64 as JSON string. See .claude/rules/proto-files.md. */createdTime?: numbermodifiedTime?: number/** * 1-based position in the evaluation order, set through the reorder and settings endpoints. */evaluationOrder?: number/** * Epoch seconds after which the rule is no longer evaluated. 0 means never. */expireTime?: number}
Was this helpful?

Set auth access policy settings POST

Update the project-level auth access policy settings. ruleIds sets the full evaluation order and must list every rule exactly once. Fields that are not sent keep their stored values, using a valid management key.

Create connector POST

Create a connector from a template, using a valid management key. `type` is the template id from LoadAllConnectorTemplates, and `configuration` holds the template's fields by name as GetConnectorTemplate describes them. The server checks the configuration against the template before saving it: required fields must be set, values must match their field's type, allowed options and dependencies, unknown fields are rejected, and missing fields with a default are filled in. Returns the stored connector, with secret values as `PLACEHOLDER_VALUE` and defaults filled in. Messaging provider types such as `sendgrid`, except `smtp`, are stored as messaging providers with ids starting with `MP` and are not checked, since they have no template. A connector does nothing by itself; the template's `types` says how it is used: a `flows` connector is called from a flow by the `connector` action with the connector's id (agents on the Descope MCP find it with GetActionCatalog, query `connector`), or automatically on events when the template has auto-trigger settings and they are on, and an `audit` connector streams audit events while its `auditEnabled` configuration field is true (the default), or always when the template has no such field.