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 theRead User Info
permission.For
POST
andDELETE
operations, your API token must have theManage Users
permission.
Operations
The email address of the user
The family/last name of the user
The given/first name of the user
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"
}
ID of the user
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"
}
ID of the user
The email address of the user
The family/last name of the user
The given/first name of the user
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"
}
ID of the user
DELETE /users/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*
No content
Pagination token
Maximum number of results to return
60
Search name and email fields in a case-insensitive fashion
An exact match of a user's email to return. If provided all other parameters are ignored
Set of IDS to return
A comma delimited list of IDs
Include deactivated users
Show only users with this Cognito status
GET /users HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*
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"
}
]
}
Last updated
Was this helpful?