PUT /api/v1/realm-assignments/{assignmentId}

Replaces a realm assignment

Servers

Path parameters

Name Type Required Description
assignmentId String Yes

ID of the realm assignment

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
priority Integer No

The priority of the realm assignment. The lower the number, the higher the priority. This helps resolve conflicts between realm assignments.

Note: When you create realm assignments in bulk, realm assignment priorities must be unique.

actions Object No

Action to apply to a user

actions.assignUserToRealm Object No

Action that assigns a user to a realm

actions.assignUserToRealm.realmId String No

ID of the realm

name String No
conditions Object No

Conditions of applying realm assignment

conditions.profileSourceId String No

ID of the profile source

conditions.expression Object No

Conditional expression

conditions.expression.value String No

Value of the condition expression

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.