PUT /api/v1/apps/{appId}/groups/{groupId}

Assigns a Group to an app, which in turn assigns the app to each User that belongs to the group. The resulting Application User scope is GROUP since the assignment was from the group membership.

Servers

Path parameters

Name Type Required Description
groupId String Yes

The id of the group

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
id String No

ID of the Group

profile Object No

Specifies the profile properties applied to Application Users that are assigned to the app through group membership. Some reference properties are imported from the target app and can't be configured. See profile.

priority Integer No

Priority assigned to the group. If an app has more than one group assigned to the same user, then the group with the higher priority has its profile applied to the Application User. If a priority value isn't specified, then the next highest priority is assigned by default. See Assign attribute group priority and the sample priority use case.

_embedded Object No

Embedded resource related to the Application Group using the JSON Hypertext Application Language specification. If the expand=group query parameter is specified, then the Group object is embedded. If the expand=metadata query parameter is specified, then the group assignment metadata is embedded.

lastUpdated String No

Timestamp when the object was last updated

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.