Delete a Custom Attributes | API Reference

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

names?array<string>

string

Delete a custom attributes to configure on users within a project, using a valid management key.

This API endpoint will delete a custom attribute within a project.

{
  "data": [
    {
      "name": "string",
      "type": 0,
      "options": [
        {
          "value": "string",
          "label": "string"
        }
      ],
      "displayName": "string",
      "defaultValue": {
        "@type": "string"
      },
      "viewPermissions": [
        "string"
      ],
      "editPermissions": [
        "string"
      ],
      "editable": true
    }
  ],
  "total": "string"
}

{  "data": [    {      "name": "string",      "type": 0,      "options": [        {          "value": "string",          "label": "string"        }      ],      "displayName": "string",      "defaultValue": {        "@type": "string"      },      "viewPermissions": [        "string"      ],      "editPermissions": [        "string"      ],      "editable": true    }  ],  "total": "string"}

TypeScript

export interface Response {
data?: {
name?: string
type?: number
options?: CustomAttributeOption[]
displayName?: string
defaultValue?: GoogleProtobuf
viewPermissions?: string[]
editPermissions?: string[]
/**
 * this is to know if this specific user can edit this specific field
 */
editable?: boolean
}[]
total?: string
}
/**
 * Custom Attributes
 */
export interface CustomAttributeOption {
value?: string
label?: string
}
/**
 * Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
 */
export interface GoogleProtobuf {
/**
 * The type of the serialized message.
 */
"@type"?: string
[k: string]: unknown
}

export interface Response {data?: {name?: stringtype?: numberoptions?: CustomAttributeOption[]displayName?: stringdefaultValue?: GoogleProtobufviewPermissions?: string[]editPermissions?: string[]/** * this is to know if this specific user can edit this specific field */editable?: boolean}[]total?: string}/** * Custom Attributes */export interface CustomAttributeOption {value?: stringlabel?: string}/** * Contains an arbitrary serialized message along with a @type that describes the type of the serialized message. */export interface GoogleProtobuf {/** * The type of the serialized message. */"@type"?: string[k: string]: unknown}

Was this helpful?

Ask AI about this page

Authorization

Request Body

Delete a custom attributes to configure on users within a project, using a valid management key.

See also