group_memberships

Creates, updates, deletes, gets or lists a group_memberships resource.

Overview

Name	group_memberships
Type	Resource
Id	okta.identity_sources.group_memberships

Fields

The following fields are returned by SELECT queries:

get_identity_source_group_memberships

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_identity_source_group_memberships	select	identitySourceId, groupOrExternalId, subdomain	after, limit	Retrieves the group memberships for the given identity source group in the given identity source instance
create_identity_source_groups_memberships	insert	identitySourceId, groupOrExternalId, subdomain		Creates the group memberships for the given identity source group
delete_identity_source_group_memberships	delete	identitySourceId, groupOrExternalId, memberExternalId, subdomain		Deletes group memberships for the specified identity source group using member external IDs

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
groupOrExternalId	string	The Okta group ID or external ID of the identity source group (example: 00gsl4xM9ys8TdnbZ0g4 or GROUPEXT123456784C2IF)
identitySourceId	string	The ID of the identity source for which the session is created (example: 0oa3l6l6WK6h0R0QW0g4)
memberExternalId	string	The external ID of the identity source user (example: USEREXT123456784C2IFA)
subdomain	string	(default: my-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 Link response header. See Pagination and Link header.
limit	integer (int32)	Specifies the number of group membership results in a page. Okta recommends using a specific value other than the default or maximum. If your request times out, retry your request with a smaller limit and page the results.

SELECT examples

get_identity_source_group_memberships

Retrieves the group memberships for the given identity source group in the given identity source instance

SELECT
*
FROM okta.identity_sources.group_memberships
WHERE identitySourceId = '{{ identitySourceId }}' -- required
AND groupOrExternalId = '{{ groupOrExternalId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
AND limit = '{{ limit }}'
;

INSERT examples

create_identity_source_groups_memberships

Creates the group memberships for the given identity source group

INSERT INTO okta.identity_sources.group_memberships (
memberExternalId,
identitySourceId,
groupOrExternalId,
subdomain
)
SELECT 
'{{ memberExternalId }}',
'{{ identitySourceId }}',
'{{ groupOrExternalId }}',
'{{ subdomain }}'
;

Manifest

# Description fields are for documentation purposes
- name: group_memberships
props:
  - name: identitySourceId
    value: "{{ identitySourceId }}"
    description: Required parameter for the group_memberships resource.
  - name: groupOrExternalId
    value: "{{ groupOrExternalId }}"
    description: Required parameter for the group_memberships resource.
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the group_memberships resource.
  - name: memberExternalId
    value: "{{ memberExternalId }}"
    description: |
      The external ID of the user to be added as a member of the group in Okta

DELETE examples

delete_identity_source_group_memberships

Deletes group memberships for the specified identity source group using member external IDs

DELETE FROM okta.identity_sources.group_memberships
WHERE identitySourceId = '{{ identitySourceId }}' --required
AND groupOrExternalId = '{{ groupOrExternalId }}' --required
AND memberExternalId = '{{ memberExternalId }}' --required
AND subdomain = '{{ subdomain }}' --required
;