Users

REST API operations for users

Overview

The /users REST API operations are in open beta starting with Panther version 1.112, and are available to all customers. Please share any bug reports and feature requests with your Panther support team.

Use these API operations to interact with users in Panther.

To call the API, see the How to use the Panther REST API instructions—including directions for how to invoke it directly from this documentation page.

Required permissions

• For GET operations, your API token must have the Read User Info permission.

• For POST and DELETE operations, your API token must have the Manage Users permission.

Operations

Create a user

post

Authorizations

Body

emailstringRequired

The email address of the user

familyNamestringRequired

The family/last name of the user

givenNamestringRequired

The given/first name of the user

roleobjectRequired

Responses

application/json

objectOptional

application/json

post

HTTPcURLJavaScriptPython

POST /users HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "email": "text",
  "familyName": "text",
  "givenName": "text",
  "role": {
    "id": "text",
    "name": "text"
  }
}

{
  "createdAt": "text",
  "email": "text",
  "enabled": true,
  "familyName": "text",
  "givenName": "text",
  "id": "text",
  "lastLoggedInAt": "text",
  "role": {
    "id": "text",
    "name": "text"
  },
  "status": "text"
}

Get a user

get

Authorizations

Path parameters

idstringRequired

ID of the user

Responses

application/json

objectOptional

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /users/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "createdAt": "text",
  "email": "text",
  "enabled": true,
  "familyName": "text",
  "givenName": "text",
  "id": "text",
  "lastLoggedInAt": "text",
  "role": {
    "id": "text",
    "name": "text"
  },
  "status": "text"
}

Update a user

post

Authorizations

Path parameters

idstringRequired

ID of the user

Body

emailstringRequired

The email address of the user

familyNamestringRequired

The family/last name of the user

givenNamestringRequired

The given/first name of the user

roleobjectRequired

Responses

application/json

objectOptional

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /users/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "email": "text",
  "familyName": "text",
  "givenName": "text",
  "role": {
    "id": "text",
    "name": "text"
  }
}

{
  "createdAt": "text",
  "email": "text",
  "enabled": true,
  "familyName": "text",
  "givenName": "text",
  "id": "text",
  "lastLoggedInAt": "text",
  "role": {
    "id": "text",
    "name": "text"
  },
  "status": "text"
}

Delete a user

delete

Authorizations

Path parameters

idstringRequired

ID of the user

Responses

application/json

application/json

delete

HTTPcURLJavaScriptPython

DELETE /users/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

No content

List users

get

Authorizations

Query parameters

containsstringOptional

Search name and email fields in a case-insensitive fashion

emailstringOptional

An exact match of a user's email to return. If provided all other parameters are ignored

idstring[]Optional

Set of IDS to return

idsstringOptional

A comma delimited list of IDs

include-deactivatedbooleanOptional

Include deactivated users

sort-dirstring · enumOptional

The sort direction of the results

Default: ascAvailable options:

statusstringOptional

Show only users with this Cognito status

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /users HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

200

OK response.

{
  "next": "text",
  "results": [
    {
      "createdAt": "text",
      "email": "text",
      "enabled": true,
      "familyName": "text",
      "givenName": "text",
      "id": "text",
      "lastLoggedInAt": "text",
      "role": {
        "id": "text",
        "name": "text"
      },
      "status": "text"
    }
  ]
}