The Groups API provides operations to manage Okta Groups and their user members for your organization.
okta.groups.read
Lists all groups with pagination support. A subset of groups can be returned that match a supported filter expression or query.
Success
Forbidden
Too Many Requests
[- {
- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastMembershipUpdated": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "objectClass": [
- "string"
], - "profile": {
- "description": "string",
- "name": "string"
}, - "type": "APP_GROUP",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "apps": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "logo": [
- {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
], - "source": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "users": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
]
okta.groups.manage
Creates a new group with OKTA_GROUP
type
Success
Bad Request
Forbidden
Too Many Requests
{- "profile": {
- "description": "string",
- "name": "string"
}, - "type": "APP_GROUP"
}
{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastMembershipUpdated": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "objectClass": [
- "string"
], - "profile": {
- "description": "string",
- "name": "string"
}, - "type": "APP_GROUP",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "apps": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "logo": [
- {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
], - "source": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "users": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.groups.read
Lists all group rules
Success
Forbidden
Too Many Requests
[- {
- "actions": {
- "assignUserToGroups": {
- "groupIds": [
- "string"
]
}
}, - "conditions": {
- "expression": {
- "type": "string",
- "value": "string"
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "string"
}
]
okta.groups.manage
Creates a group rule to dynamically add users to the specified group if they match the condition
Success
Bad Request
Forbidden
Too Many Requests
{- "actions": {
- "assignUserToGroups": {
- "groupIds": [
- "string"
]
}
}, - "conditions": {
- "expression": {
- "type": "string",
- "value": "string"
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}, - "name": "string",
- "status": "ACTIVE",
- "type": "string"
}
{- "actions": {
- "assignUserToGroups": {
- "groupIds": [
- "string"
]
}
}, - "conditions": {
- "expression": {
- "type": "string",
- "value": "string"
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "string"
}
okta.groups.read
Retrieves a specific group rule by groupRuleId
Success
Forbidden
Not Found
Too Many Requests
{- "actions": {
- "assignUserToGroups": {
- "groupIds": [
- "string"
]
}
}, - "conditions": {
- "expression": {
- "type": "string",
- "value": "string"
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "string"
}
okta.groups.manage
Replaces a group rule. Only INACTIVE
rules can be updated.
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "actions": {
- "assignUserToGroups": {
- "groupIds": [
- "string"
]
}
}, - "conditions": {
- "expression": {
- "type": "string",
- "value": "string"
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}, - "name": "string",
- "status": "ACTIVE",
- "type": "string"
}
{- "actions": {
- "assignUserToGroups": {
- "groupIds": [
- "string"
]
}
}, - "conditions": {
- "expression": {
- "type": "string",
- "value": "string"
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "string"
}
okta.groups.manage
Deletes a specific group rule by groupRuleId
Accepted
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.groups.manage
Activates a specific group rule by groupRuleId
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.groups.manage
Deactivates a specific group rule by groupRuleId
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.groups.read
Retrieves a group by groupId
Success
Forbidden
Not Found
Too Many Requests
{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastMembershipUpdated": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "objectClass": [
- "string"
], - "profile": {
- "description": "string",
- "name": "string"
}, - "type": "APP_GROUP",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "apps": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "logo": [
- {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
], - "source": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "users": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.groups.manage
Replaces the profile for a group with OKTA_GROUP
type
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "profile": {
- "description": "string",
- "name": "string"
}, - "type": "APP_GROUP"
}
{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastMembershipUpdated": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "objectClass": [
- "string"
], - "profile": {
- "description": "string",
- "name": "string"
}, - "type": "APP_GROUP",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "apps": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "logo": [
- {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
], - "source": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "users": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.groups.manage
Deletes a group with OKTA_GROUP
type
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.groups.read
Lists all applications that are assigned to a group
Success
Forbidden
Not Found
Too Many Requests
[- {
- "accessibility": {
- "errorRedirectUrl": "string",
- "loginRedirectUrl": "string",
- "selfService": true
}, - "created": "2019-08-24T14:15:22Z",
- "features": [
- "string"
], - "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "licensing": {
- "seatCount": 0
}, - "profile": {
- "property1": { },
- "property2": { }
}, - "signOnMode": "AUTO_LOGIN",
- "status": "ACTIVE",
- "visibility": {
- "appLinks": {
- "property1": true,
- "property2": true
}, - "autoLaunch": true,
- "autoSubmitToolbar": true,
- "hide": {
- "iOS": true,
- "web": true
}
}, - "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "accessPolicy": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "activate": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "deactivate": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "groups": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "logo": [
- {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
], - "metadata": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "users": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
]
okta.groups.read
Lists all owners for a specific group
Success
Forbidden
Not Found
Too Many Requests
[- {
- "id": "00g1gae1k0znUcLuU0h8",
- "type": "GROUP",
- "resolved": true,
- "originId": "null",
- "originType": "OKTA_DIRECTORY",
- "displayName": "Product & Engineering",
- "lastUpdated": "2023-03-29 18:18:37.0"
}
]
okta.groups.manage
Assigns a group owner
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "id": "00u1cmc03xjzePoWD0h8",
- "type": "USER"
}
{- "id": "00u1cmc03xjzePoWD0h8",
- "type": "USER",
- "resolved": true,
- "originId": null,
- "originType": "OKTA_DIRECTORY",
- "displayName": "Oliver Putnam",
- "lastUpdated": "Wed Mar 29 18:34:31 UTC 2023"
}
okta.groups.manage
Deletes a group owner from a specific 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": [ ]
}
okta.groups.read
Lists all users that are a member of a group
Success
Forbidden
Not Found
Too Many Requests
[- {
- "activated": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "password": {
- "hash": {
- "algorithm": "BCRYPT",
- "digestAlgorithm": "SHA256_HMAC",
- "iterationCount": 0,
- "keySize": 0,
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "provider": {
- "name": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "recovery_question": {
- "answer": "string",
- "question": "string"
}
}, - "id": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "passwordChanged": "2019-08-24T14:15:22Z",
- "profile": {
- "city": "string",
- "costCenter": "string",
- "countryCode": "st",
- "department": "string",
- "displayName": "string",
- "division": "string",
- "email": "user@example.com",
- "employeeNumber": "string",
- "firstName": "string",
- "honorificPrefix": "string",
- "honorificSuffix": "string",
- "lastName": "string",
- "locale": "string",
- "login": "string",
- "manager": "string",
- "managerId": "string",
- "middleName": "string",
- "mobilePhone": "string",
- "nickName": "string",
- "organization": "string",
- "postalAddress": "string",
- "preferredLanguage": "string",
- "primaryPhone": "string",
- "profileUrl": "string",
- "secondEmail": "user@example.com",
- "state": "string",
- "streetAddress": "string",
- "timezone": "string",
- "title": "string",
- "userType": "string",
- "zipCode": "string",
- "property1": null,
- "property2": null
}, - "status": "ACTIVE",
- "statusChanged": "2019-08-24T14:15:22Z",
- "transitioningToStatus": "ACTIVE",
- "type": {
- "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "schema": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}, - "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
]
okta.groups.manage
Assigns a user to a group with 'OKTA_GROUP' type
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.groups.manage
Unassigns a user from a group with 'OKTA_GROUP' type
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": [ ]
}