Users

REST API operations for users

Overview

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

ApiKeyAuth

X-API-KeystringRequired

Body

application/json

emailstringRequired

The email address of the user

familyNamestringRequired

The family/last name of the user

givenNamestringRequired

The given/first name of the user

Responses

200

OK response.

application/json

createdAtstringOptional

emailstringRequired

The email address of the user

enabledbooleanRequired

Whether the user is active or deactivated

familyNamestringRequired

The family/last name of the user

givenNamestringRequired

The given/first name of the user

idstringOptional

ID of the user

lastLoggedInAtstringOptional

statusstringOptional

The Cognito auth-related status of this User

400

bad_request: Bad Request response.

application/json

post

/users

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

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the user

Responses

200

OK response.

application/json

createdAtstringOptional

emailstringRequired

The email address of the user

enabledbooleanRequired

Whether the user is active or deactivated

familyNamestringRequired

The family/last name of the user

givenNamestringRequired

The given/first name of the user

idstringOptional

ID of the user

lastLoggedInAtstringOptional

statusstringOptional

The Cognito auth-related status of this User

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

get

/users/{id}

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

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the user

Body

application/json

emailstringRequired

The email address of the user

familyNamestringRequired

The family/last name of the user

givenNamestringRequired

The given/first name of the user

Responses

200

OK response.

application/json

createdAtstringOptional

emailstringRequired

The email address of the user

enabledbooleanRequired

Whether the user is active or deactivated

familyNamestringRequired

The family/last name of the user

givenNamestringRequired

The given/first name of the user

idstringOptional

ID of the user

lastLoggedInAtstringOptional

statusstringOptional

The Cognito auth-related status of this User

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

post

/users/{id}

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

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the user

Responses

200

OK response.

No content

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

delete

/users/{id}

HTTPcURLJavaScriptPython

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

No content

List users

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Query parameters

cursorstringOptional

Pagination token

limitinteger · int64 · min: 1 · max: 60Optional

Maximum number of results to return

Default: 60

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

statusstringOptional

Show only users with this Cognito status

Responses

200

OK response.

application/json

nextstringOptional

Pagination token for the next page of results

get

/users

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"
    }
  ]
}