POST /api/v1/apps/{appId}/group-push/mappings
Creates or links a group push mapping.
Note: Either targetGroupId or targetGroupName must be provided, but not both. If targetGroupId is provided, it links to an existing group. If targetGroupName is provided, it creates a new group.
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
appId |
String | Yes |
Application ID |
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 |
|---|---|---|---|
sourceGroupId |
String | Yes |
The ID of the source group for the group push mapping |
appConfig |
Object | No |
Additional app configuration for group push mappings. Currently only required for Active Directory. |
appConfig.type |
String | No |
The type of the app configuration Valid values:
|
status |
String | No |
The status of the group push mapping Valid values:
Default value: "ACTIVE" |
targetGroupName |
String | No |
The name of the target group for the group push mapping. This is used when creating a new downstream group. If the group already exists, it links to the existing group. Required if |
targetGroupId |
String | No |
The ID of the existing target group for the group push mapping. This is used to link to an existing group. Required if |
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.