Eng Intel: User Labels

Use these operations to interact with user labels in Cortex Eng Intelligence.

Required permissions

Your API key must have the Configure user labels permission.

Operations

List user labels

get

Retrieves a list of all available user labels.

API key must have the View Eng Intelligence permission.

Authorizations

Query parameters

pageSizeinteger · int32 · default: 250required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger · int32 · default: 0required

Page number to return, 0-indexed. Default 0.

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/eng-intel/labels?pageSize=1&page=1' \
  --header 'Authorization: Bearer JWT'

200

429

200

{
  "labels": [
    {
      "description": "text",
      "id": "ul2da8159dbeefb974",
      "name": "text",
      "values": [
        "text"
      ]
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Successfully retrieved user labels

Retrieve user label

get

Get user label.

API key must have the View Eng Intelligence permission.

Authorizations

Path parameters

idstringrequired

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/eng-intel/labels/{id}' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

{
  "description": "text",
  "id": "ul2da8159dbeefb974",
  "name": "text",
  "values": [
    "text"
  ]
}

Successfully retrieved user label

Update user label assignments

post

Assign user label values to user emails in bulk.

API key must have the Edit user labels permission.

Authorizations

Body

userLabelAssignmentsobjectrequired

Map of user email to the list of user label values that should be assigned to the user

Example: { "[e-mail]": [ {"id": "ul2da8159dbeefb974", "name": "Coding Language", "value": "Java"}, {"id": "ul2da8159234bsdfas", "name": "Engineering Level", "value": "Senior"} ], "[e-mail]": [ {"id": "ul2da8159dbeefb974", "name": "Coding Language", "value": "Typescript"}, ] }

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/eng-intel/labels/users' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "userLabelAssignments": "
              {
                  \"[e-mail]\": [
                      {\"id\": \"ul2da8159dbeefb974\", \"name\": \"Coding Language\", \"value\": \"Java\"},
                      {\"id\": \"ul2da8159234bsdfas\", \"name\": \"Engineering Level\", \"value\": \"Senior\"}
                  ],
                  \"[e-mail]\": [
                      {\"id\": \"ul2da8159dbeefb974\", \"name\": \"Coding Language\", \"value\": \"Typescript\"},
                  ]
              }
          "
  }'

200

429

200

{
  "userLabelAssignments": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "id": "text",
        "name": "text",
        "value": "text"
      }
    ]
  }
}

Successfully updated user label assignments