API reference¶
This section provides technical details for the Permission Assist API, including endpoint specifications, request and response schemas, authentication details, and error codes.
Authentication and errors¶
| Section | Description |
|---|---|
| Authentication | How to authenticate API requests |
| Error codes | HTTP status codes and error response format |
Personnel events¶
| Endpoint | Description |
|---|---|
| All personnel events | List personnel events with optional filters |
| Get personnel event | Retrieve a single personnel event by ID |
| Create onboard | Create an Onboarding event |
| Create offboard | Create an Offboarding event |
| Create role transition | Create a Role Transition event |
| Create leave of absence | Create a Leave of Absence event |
Application imports¶
| Endpoint | Description |
|---|---|
| All application imports | List application imports with optional filters |
| Get application import | Retrieve a single application import by ID |
| Stage import | Stage an import using an existing schedule |
| Upload import | Upload files directly for import |
| Cancel import | Cancel a staged or in-progress import |
Applications¶
| Endpoint | Description |
|---|---|
| All applications | List all applications |
| Get application | Retrieve a single application by ID |
Identities¶
| Endpoint | Description |
|---|---|
| All identities | List all identities |
| Get identity | Retrieve a single identity by ID |
Access requests¶
| Endpoint | Description |
|---|---|
| All access requests | List access requests with optional filters |
| Get access request | Retrieve a single access request by ID |
Base URL¶
All API requests use the following base URL:
Replace [your-pa-server] with the hostname or IP address of your
Permission Assist server.
Request format¶
All API requests must include the following headers:
| Header | Value |
|---|---|
Content-Type |
application/json (or multipart/form-data for file uploads) |
Authorization |
Bearer [your-token] |
Request bodies use JSON format unless otherwise noted.
Response format¶
All API responses use JSON format. Successful responses include the requested data. Error responses include a structured error object. Refer to Error codes for the error response format.
Pagination¶
List endpoints return paginated results. Pass the page query parameter
to navigate through pages. The page size is fixed at 50 results per page.