What we’ll cover:
Applicable Roles:
-
HR Connect Administrator
Quick Reference Links:
Getting Started with Role Assignments
Users need various roles to perform certain functions in the Cayuse system. The Role Assignments API will load Role Assignments for Users into the Cayuse system.
- All column headers of the CSV are required, however the value for the column is not required (unless specified).
- Values provided will be merged into the existing records with the Cayuse system.
- Deleting records and removing values are not supported at this time.
API
Request:
|
Type |
Value |
|
Protocol |
HTTPS |
|
Method |
POST |
|
URL |
/api/v2/administration/batch/upload/role |
|
Header |
Content-Type: text/csv |
|
Header |
X-Idp-New-Login: true |
Example:
# Call to upload the CSV
curl -H "Authorization: Bearer $AUTHORIZATON_TOKEN" \
-H "Content-Type: text/csv" \
-H "X-Idp-New-Login: true" \
-X POST \
--data-binary "@$CSV_FILE" \
"https://$HOST/api/v2/administration/batch/upload/role"
Response (Json String):
|
Name |
Type |
Description |
|
jobId |
UUID |
Identifier for the job to query status or get the report |
Example:
{"jobId":"66c586ae-31cb-47a9-9155-bf76460a3bec"}