POST /api/v1/directories/{appInstanceId}/groups/modify
Updates an Active Directory group membership directly in Active Directory
Note: See Before you begin: Active Directory integration with the following setup in the Use Okta Access Certifications to manage AD group membership product documentation.
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
appInstanceId |
String | Yes |
ID of the Active Directory app instance in Okta |
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 Active Directory group to update |
parameters |
Object | No |
Attributes used for processing Active Directory group membership update |
parameters.values[] |
Array | No |
List of user IDs whose group memberships to update |
parameters.action |
String | No |
The update action to take Valid values:
|
parameters.attribute |
String | No |
The attribute that tracks group memberships in Active Directory. For Active Directory, use |
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.