PUT /api/v1/groups/rules/{groupRuleId}

Replaces a Group rule

Notes: You only can update rules with a Group whose status is set to 'INACTIVE'.

You currently can't update the action section.

Servers

https://{yourOktaDomain}

Path parameters

Name	Type	Required	Description
`groupRuleId`	String	Yes	The `id` of the group rule

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	ID of the group rule
`actions`	Object	No	Defines which users and groups to assign
`actions.assignUserToGroups`	Object	No	Contains the `groupIds` array
`actions.assignUserToGroups.groupIds[]`	Array	No	Array of `groupIds` to which Users are added
`created`	String	No	Creation date for group rule
`name`	String	No	Name of the Group rule
`conditions`	Object	No	Defines group rule conditions
`conditions.expression`	Object	No	Defines Okta specific group-rules expression
`conditions.expression.type`	String	No	Expression type. Only valid value is '`urn:okta:expression:1.0`'.
`conditions.expression.value`	String	No	Okta expression that would result in a Boolean value
`conditions.people`	Object	No	Defines conditions for `people` in a group rule
`conditions.people.groups`	Object	No	Currently not supported
`conditions.people.groups.exclude[]`	Array	No	Currently not supported
`conditions.people.users`	Object	No	Defines conditions specific to user exclusion
`conditions.people.users.exclude[]`	Array	No	Excluded `userIds` when processing rules
`type`	String	No	Type to indicate a Group rule operation. Only `group_rule` is allowed.
`status`	String	No	Status of group rule Possible values: `"INVALID"` `"ACTIVE"` `"INACTIVE"`
`lastUpdated`	String	No	Date group rule 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.