group_schemas

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

Overview

Name	group_schemas
Type	Resource
Id	okta.meta.group_schemas

Fields

The following fields are returned by SELECT queries:

get_group_schema

successful operation

Name	Datatype	Description
id	string	URI of group schema
name	string	Name of the schema
$schema	string	JSON schema version identifier
_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	Timestamp when the schema was created
definitions	object
description	string	Description for the schema
lastUpdated	string	Timestamp when the schema was last updated
properties	object	Group object properties
title	string	User-defined display name for the schema
type	string	Type of root schema

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_group_schema	select	subdomain		Retrieves the group schema The User Types feature does not extend to groups. All groups use the same group schema. Unlike user schema operations, group schema operations all specify default and don't accept a schema ID.
update_group_schema	update	subdomain		Updates the group profile schema. This updates, adds, or removes one or more custom profile properties in a group schema. Currently Okta does not support changing base group profile properties. > Note: You must set properties explicitly to null to remove them from the schema; otherwise, POST is interpreted as a partial update. The User Types feature does not extend to groups. All groups use the same group schema. Unlike user schema operations, group schema operations all specify default and don't accept a schema ID.

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

get_group_schema

Retrieves the group schema

The User Types feature does not extend to groups. All groups use the same group schema. Unlike user schema operations, group schema operations all specify default and don't accept a schema ID.

SELECT
id,
name,
$schema,
_links,
created,
definitions,
description,
lastUpdated,
properties,
title,
type
FROM okta.meta.group_schemas
WHERE subdomain = '{{ subdomain }}' -- required
;

UPDATE examples

update_group_schema

Updates the group profile schema. This updates, adds, or removes one or more custom profile properties in a group schema. Currently Okta does not support changing base group profile properties.

> Note: You must set properties explicitly to null to remove them from the schema; otherwise, POST is interpreted as a partial update.

The User Types feature does not extend to groups. All groups use the same group schema. Unlike user schema operations, group schema operations all specify default and don't accept a schema ID.

UPDATE okta.meta.group_schemas
SET 
data__definitions = '{{ definitions }}',
data__description = '{{ description }}',
data__properties = '{{ properties }}',
data__title = '{{ title }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
id,
name,
$schema,
_links,
created,
definitions,
description,
lastUpdated,
properties,
title,
type
;