POST /api/v1/meta/schemas/group/default

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.

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.

Note: Since POST is interpreted as a partial update, you must set properties explicitly to null to remove them from the Schema.

Servers

https://{yourOktaDomain}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	URI of Group Schema
`_links`	Object	No	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	No	Timestamp when the Schema was created
`name`	String	No	Name of the Schema
`description`	String	No	Description for the Schema
`properties`	Object	No
`properties.profile`	Object	No
`properties.profile.allOf[]`	Array	No
`properties.profile.allOf[].$ref`	String	No
`definitions`	Object	No
`definitions.custom`	Object	No	All custom Profile properties are defined in a Profile subschema with the resolution scope `#custom`
`definitions.custom.id`	String	No	The subschema name
`definitions.custom.properties`	Object	No	The `#custom` object properties
`definitions.custom.properties.name`	Object	No
`definitions.custom.properties.name.unique`	String	No
`definitions.custom.properties.name.description`	String	No	Description of the property
`definitions.custom.properties.name.required`	Boolean	No	Determines whether the property is required
`definitions.custom.properties.name.items`	Object	No
`definitions.custom.properties.name.items.enum[]`	Array	No
`definitions.custom.properties.name.items.type`	String	No
`definitions.custom.properties.name.items.oneOf[]`	Array	No
`definitions.custom.properties.name.items.oneOf[].title`	String	No
`definitions.custom.properties.name.items.oneOf[].const`	String	No
`definitions.custom.properties.name.externalName`	String	No	Name of the property as it exists in an external application
`definitions.custom.properties.name.scope`	String	No	Determines whether a group attribute can be set at the individual or group level Possible values: `"SELF"` `"NONE"`
`definitions.custom.properties.name.maxLength`	Integer	No	Maximum character length of a string property
`definitions.custom.properties.name.permissions[]`	Array	No	Access control permissions for the property
`definitions.custom.properties.name.permissions[].action`	String	No	Determines whether the principal can view or modify the property
`definitions.custom.properties.name.permissions[].principal`	String	No	Security principal
`definitions.custom.properties.name.minLength`	Integer	No	Minimum character length of a string property
`definitions.custom.properties.name.format`	String	No	Identifies the type of data represented by the string Possible values: `"ref-id"` `"date-time"` `"email"` `"language-code"` `"locale"` `"encrypted"` `"hashed"` `"country-code"` `"timezone"` `"uri"`
`definitions.custom.properties.name.mutability`	String	No	Defines the mutability of the property Possible values: `"WRITE_ONLY"` `"READ_ONLY"` `"READ_WRITE"` `"IMMUTABLE"`
`definitions.custom.properties.name.enum[]`	Array	No	Enumerated value of the property. The value of the property is limited to one of the values specified in the enum definition. The list of values for the enum must consist of unique elements.
`definitions.custom.properties.name.title`	String	No	User-defined display name for the property
`definitions.custom.properties.name.type`	String	No	Type of property Possible values: `"string"` `"boolean"` `"integer"` `"number"` `"array"`
`definitions.custom.properties.name.externalNamespace`	String	No	Namespace from the external application
`definitions.custom.properties.name.oneOf[]`	Array	No	Non-empty array of valid JSON schemas. Okta only supports `oneOf` for specifying display names for an `enum`. Each schema has the following format: { "const": "enumValue", "title": "display name" } ```json When `enum` is used in conjunction with `oneOf`, you must keep the set of enumerated values and their order. `{"enum": ["S","M","L","XL"], "oneOf": [ {"const": "S", "title": "Small"}, {"const": "M", "title": "Medium"}, {"const": "L", "title": "Large"}, {"const": "XL", "title": "Extra Large"} ] }` The `oneOf` key is only supported in conjunction with `enum` and provides a mechanism to return a display name for the `enum` value.
`definitions.custom.properties.name.oneOf[].title`	String	No
`definitions.custom.properties.name.oneOf[].const`	String	No
`definitions.custom.required[]`	Array	No	A collection indicating required property names
`definitions.custom.type`	String	No	The object type
`definitions.base`	Object	No
`definitions.base.id`	String	No	The subschema name
`definitions.base.required[]`	Array	No	A collection indicating required property names
`definitions.base.type`	String	No	The object type
`title`	String	No	User-defined display name for the Schema
`type`	String	No	Type of root Schema
`$schema`	String	No	JSON Schema version identifier
`lastUpdated`	String	No	Timestamp when the Schema was last updated

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.