logo

User

This document describes the API for reading and updating Users.

List Users

Returns a list of Users.

Search parameters

Filter Description
active Flag to indicate if this User is active
department_id The department_id of the User
email The email of the User
employee_type The employee_type of the User
end_date The end date for the User
first_name The first name of the User
id The ID of the User
in_audit_scope Flag to indicate if the User is in audit scope
invited Flag to indicate if this User has been invited
invited_at The date the User was invited
last_name The last name of the User
name The name of the User
onboarding_status The onboarding status of the User
personnel_status The personnel status of the User
preferred_first_name The preferred first name of the User
secureframe_agent_acknowledged_at The date that the User acknowledged secureframe agent
start_date The start date of the User
title The title of the User
Securityheader_authorization
Request
query Parameters
include
boolean

Set to true along with relationships to return the entire relationship data in the included key within the response.

page
integer

Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive.

per_page
integer

Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page.

q
string

Search and filter the user data using Lucene syntax.

relationships
boolean

Set to true to return the associated relationships data within the response. (default: false)

Responses
400

Bad Request

401

Unauthorized

403

Forbidden

default
get/users
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get a User
Returns a User by ID


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
get/users/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
Update a User
Update a User by ID


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
query Parameters
active
boolean
True if the user account is active, false if it has been disabled.


 
employee_type
string
The type of employee.


 Enum: "contractor" "employee" "non_employee" "auditor" "external"  
end_date
string <date-time> 
Date when the user's employement ended in ISO 8601 format.


 
in_audit_scope
boolean
True if the user should be audited, false otherwise - only updateable in certain cases.


 
start_date
string <date-time> 
Date when the user's employement started in ISO 8601 format.


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
put/users/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
➔ Next to User Account