The IAM Governance Bundle API provides operations for managing governance entitlement bundles, including roles and resources associated with the bundles, for the Admin Console. For details on governance bundles for the Admin Console, see Govern Okta admin roles and Entitlement Management.
Lists all governance bundles for the Admin Console in your org
| after | string The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the |
| limit | integer [ 1 .. 200 ] Default: 20 A limit on the number of objects to return |
OK
Forbidden
Too Many Requests
{- "bundles": [
- {
- "id": "0bbfxqCAJWWGELFTYAAA",
- "name": "Group admin bundle",
- "description": "Group bundle for administrative access",
- "status": "ACTIVE",
- "orn": "orn:okta:governance:00o5rb5mt2H3d1TJd0h7:bundles:0bbfxqCAJWWGELFTYAAA",
- "_links": {
}
}
], - "_links": {
}
}Creates a governance bundle of entitlements for the Admin Console
Success
Bad Request
Forbidden
Too Many Requests
{- "name": "Group admin bundle",
- "description": "Group bundle for administrative access",
- "entitlements": {
- "role": "GROUP_MEMBERSHIP_ADMIN"
}
}{- "id": "0bbfxqCAJWWGELFTYAAA",
- "name": "Group admin bundle",
- "description": "Group bundle for administrative access",
- "status": "ACTIVE",
- "orn": "orn:okta:governance:00o5rb5mt2H3d1TJd0h7:bundles:0bbfxqCAJWWGELFTYAAA",
}Retrieves a governance bundle for the Admin Console
OK
Bad Request
Forbidden
Too Many Requests
{- "id": "0bbfxqCAJWWGELFTYAAA",
- "name": "Group admin bundle",
- "description": "Group bundle for administrative access",
- "status": "ACTIVE",
- "orn": "orn:okta:governance:00o5rb5mt2H3d1TJd0h7:bundles:0bbfxqCAJWWGELFTYAAA",
}Replaces the properties of a governance bundle for the Admin Console
Success
Bad Request
Forbidden
Too Many Requests
{- "name": "Group admin bundle",
- "description": "Group bundle for administrative access",
- "entitlements": {
- "role": "GROUP_MEMBERSHIP_ADMIN"
}
}{- "id": "0bbfxqCAJWWGELFTYAAA",
- "name": "Group admin bundle",
- "description": "Group bundle for administrative access",
- "status": "ACTIVE",
- "orn": "orn:okta:governance:00o5rb5mt2H3d1TJd0h7:bundles:0bbfxqCAJWWGELFTYAAA",
}Deletes an Admin Console governance bundle
No Content
Forbidden
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}Lists all entitlements specific to a governance bundle
| after | string The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the |
| limit | integer [ 1 .. 200 ] Default: 20 A limit on the number of objects to return |
OK
Forbidden
Too Many Requests
{- "entitlements": [
- {
- "id": "espfxqCAJWWGELFTYASJ",
- "role": "GROUP_MEMBERSHIP_ADMIN",
- "name": "Group Membership Admin",
- "description": "Perform all admin activities for groups in the org",
}
], - "_links": {
- "bundle": {
}
}
}Lists all entitlement values that are specific to a governance bundle entitlement
| after | string The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the |
| limit | integer [ 1 .. 200 ] Default: 20 A limit on the number of objects to return |
OK
Forbidden
Too Many Requests
{- "entitlementValues": [
- {
- "id": "entfxqCAJWWGELFTYAAA",
- "value": "orn:okta:00o5rb5mt2H3d1TJd0h7:groups:00guaxWZ0AOa5NFAj0g3",
- "name": "Restricted users group",
}
], - "_links": {
- "bundle": {
}, - "entitlements": {
}
}
}Retrieves the entitlement management opt-in status for the Admin Console
OK
Forbidden
Too Many Requests
{- "optInStatus": "OPTING_IN",
}Opts in the Admin Console to entitlement management
Success
Forbidden
Too Many Requests
{- "optInStatus": "OPTING_IN",
}Opts out the Admin Console from entitlement management
Success
Forbidden
Too Many Requests
{- "optInStatus": "OPTING_OUT",
}