user_groups
Creates, updates, deletes, gets or lists a user_groups resource.
Overview
| Name | user_groups |
| Type | Resource |
| Id | okta.users.user_groups |
Fields
The following fields are returned by SELECT queries:
- list_user_groups
| Name | Datatype | Description |
|---|---|---|
id | string | Unique ID for the group (example: 0gabcd1234) |
_embedded | object | Embedded resources related to the group |
_links | object | Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations. |
created | string (date-time) | Timestamp when the group was created |
lastMembershipUpdated | string (date-time) | Timestamp when the groups memberships were last updated |
lastUpdated | string (date-time) | Timestamp when the group's profile was last updated |
objectClass | array | Determines the group's profile |
profile | | Specifies required and optional properties for a group. The objectClass of a group determines which additional properties are available. You can extend group profiles with custom properties, but you must first add the properties to the group profile schema before you can reference them. Use the Profile Editor in the Admin Console or the Schemas APIto manage schema extensions. Custom properties can contain HTML tags. It is the client's responsibility to escape or encode this data before displaying it. Use best-practices to prevent cross-site scripting. |
type | string | Determines how a group's profile and memberships are managed |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_user_groups | select | subdomain | Lists all groups of which the user is a member. > Note: To list all groups in your org, use the List all groups endpoints in the Groups API. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
subdomain | string | The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org) |
SELECT examples
- list_user_groups
Lists all groups of which the user is a member.
> Note: To list all groups in your org, use the List all groups endpoints in the Groups API.
SELECT
id,
_embedded,
_links,
created,
lastMembershipUpdated,
lastUpdated,
objectClass,
profile,
type
FROM okta.users.user_groups
WHERE subdomain = '{{ subdomain }}' -- required;