Group role targets allow you to limit the app or group resources for a standard role that's assigned to a group within your org. You can define admin roles to target groups, Applications, and Application Instances.
Note: You can only use the User Role Targets API with standard roles. You can define specific targets for custom roles with Resource Set Resources. See the Role Assignments concept.
okta.roles.read
Lists all app targets for an APP_ADMIN
Role Assignment to a Group. The response includes a list of OIN-cataloged apps or app instances. The response payload for an app instance contains the id
property, but an OIN-cataloged app doesn't.
Success
Forbidden
Not Found
Too Many Requests
[- {
- "category": "string",
- "description": "string",
- "displayName": "string",
- "features": [
- "string"
], - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "signOnModes": [
- "string"
], - "status": "ACTIVE",
- "verificationStatus": "string",
- "website": "string",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}
}
}
]
okta.roles.manage
Assigns an OIN app target to an APP_ADMIN
Role Assignment to a Group. When you assign the first OIN app target, you reduce the scope of the Role Assignment. The Role no longer applies to all app targets but applies only to the specified target. An OIN app target that's assigned to the Role overrides any existing instance targets of the OIN app. For example, if a user is assigned to administer a specific Facebook instance, a successful request to add an OIN app with facebook
for appName
makes that user the administrator for all Facebook instances.
Success
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.manage
Unassigns an OIN app target from an APP_ADMIN
Role Assignment to a Group
Note: You can't remove the last app target from a Role Assignment, since this causes an exception. If you need a Role Assignment that applies to all apps, delete the
APP_ADMIN
Role Assignment and recreate a new one. See Unassign a Group Role.
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.manage
Assigns an app instance target to an APP_ADMIN
Role Assignment to a Group. When you assign the first OIN app or app instance target, you reduce the scope of the Role Assignment. The Role no longer applies to all app targets, but applies only to the specified target.
Note: You can target a mixture of both OIN app and app instance targets, but you can't assign permissions to manage all instances of an OIN app and then assign a subset of permissions to the same app. For example, you can't specify that an admin has access to manage all instances of the Salesforce app and then also manage specific configurations of the Salesforce app.
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.manage
Unassigns an app instance target from an APP_ADMIN
Role Assignment to a Group
Note: You can't remove the last app instance target from a Role Assignment since this causes an exception. > If you need a Role Assignment that applies to all apps, delete the
APP_ADMIN
Role Assignment and recreate a new one. See Unassign a Group Role.
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 Group targets for a USER_ADMIN
, HELP_DESK_ADMIN
, or GROUP_MEMBERSHIP_ADMIN
Role Assignment to a Group.
If the Role isn't scoped to specific Group targets, an empty array []
is returned.
Success
Forbidden
Not Found
Too Many Requests
[- {
- "created": "2019-08-24T14:15:22Z",
- "id": "0gabcd1234",
- "lastMembershipUpdated": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "objectClass": [
- "string"
], - "profile": {
- "description": "All users West of The Rockies",
- "name": "West Coast users"
}, - "type": "APP_GROUP",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}, - "apps": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}, - "logo": [
- {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}
], - "source": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}, - "users": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}
}
}
]
okta.roles.manage
Assigns a Group target to a USER_ADMIN
, HELP_DESK_ADMIN
, or GROUP_MEMBERSHIP_ADMIN
Role Assignment to a Group.
When you assign the first Group target, you reduce the scope of the Role Assignment. The Role no longer applies to all targets but applies only to the specified target.
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.manage
Unassigns a Group target from a USER_ADMIN
, HELP_DESK_ADMIN
, or GROUP_MEMBERSHIP_ADMIN
Role Assignment to a Group.
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": [ ]
}