PUT /api/v1/groups/{groupId}

Replaces the profile for a group of OKTA_GROUP type from your org.

Note : You only can modify profiles for groups of the OKTA_GROUP type.

App imports are responsible for updating profiles for groups of the APP_GROUP type, such as Active Directory groups.

Servers

Path parameters

Name Type Required Description
groupId String Yes

The id of the group

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
profile Object No

Profile for any group that is not imported from Active Directory. Specifies the standard and custom profile properties for a group.

The objectClass for these groups is okta:user_group.

profile.name String No

Name of the group

profile.description String No

Description of the group

profile.objectClass String No

The object class type

Valid values:

  • "okta:user_group"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.