These APIs allow you to assign custom roles to user and groups, as well as designate Third-Party Administrator status to a user or group.
okta.roles.read
Lists all assigned roles of group identified by groupId
Success
Forbidden
Not Found
Too Many Requests
[- {
- "assignmentType": "GROUP",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "status": "ACTIVE",
- "type": "API_ACCESS_MANAGEMENT_ADMIN",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
]
okta.roles.manage
Assigns a role to a group
Success
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "type": "API_ACCESS_MANAGEMENT_ADMIN"
}
{- "assignmentType": "GROUP",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "status": "ACTIVE",
- "type": "API_ACCESS_MANAGEMENT_ADMIN",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.roles.read
Retrieves a role identified by roleId
assigned to group identified by groupId
Success
Forbidden
Not Found
Too Many Requests
{- "assignmentType": "GROUP",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "status": "ACTIVE",
- "type": "API_ACCESS_MANAGEMENT_ADMIN",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.roles.manage
Unassigns a role identified by roleId
assigned to group identified by groupId
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.roles.read
Lists all users with Role Assignments
Success
Forbidden
Too Many Requests
{- "value": [
- {
- "id": "00u118oQYT4TBGuay0g4",
- "orn": "orn:okta:00o5rb5mt2H3d1TJd0h7:users:00u118oQYT4TBGuay0g4",
- "_links": {
}
}
], - "_links": {
}
}
okta.roles.read
Lists all roles assigned to a user identified by userId
Success
Forbidden
Not Found
Too Many Requests
[- {
- "assignmentType": "GROUP",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "status": "ACTIVE",
- "type": "API_ACCESS_MANAGEMENT_ADMIN",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
]
okta.roles.manage
Assigns a role to a user identified by userId
Created
Bad Request
Forbidden
Not Found
Too Many Requests
{- "type": "API_ACCESS_MANAGEMENT_ADMIN"
}
{- "assignmentType": "GROUP",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "status": "ACTIVE",
- "type": "API_ACCESS_MANAGEMENT_ADMIN",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.roles.read
Retrieves a role identified by roleId
assigned to a user identified by userId
Success
Forbidden
Not Found
Too Many Requests
{- "assignmentType": "GROUP",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "status": "ACTIVE",
- "type": "API_ACCESS_MANAGEMENT_ADMIN",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.roles.manage
Unassigns a role identified by roleId
from a user identified by userId
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}