API ReferenceManagementUsersCustom Attributes
POST
/v1/mgmt/user/customattribute/create

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

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

See also

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/user/customattribute/create

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

attributesarray<object>

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/user/customattribute/create" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>" \
  -d '{
  "attributes": [
    {
      "name": "string",
      "type": 0,
      "options": [
        {
          "value": "string",
          "label": "string"
        }
      ],
      "displayName": "string",
      "defaultValue": {
        "@type": "string"
      },
      "viewPermissions": [
        "string"
      ],
      "editPermissions": [
        "string"
      ],
      "editable": true
    }
  ]
}'

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

Was this helpful?

Previous

Get Available Custom Attributes

Next

Delete a Custom Attributes