Retrieve a rule

get https://{region}.api.clumio.com/settings/auto-user-provisioning/rules/{rule_id}

Returns a representation of the specified auto user provisioning rule.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

_embedded

object

Embedded responses related to the resource.

read-organizational-unit

string

Embeds the associated organizational units for the OU UUIDs in the response
if requested using the embed query parameter.

read-role

string

Embeds the associated role for the role UUID in the response if requested using the embed query parameter.

_links

object

URLs to pages related to the resource.

_self

object

The HATEOAS link to this resource.

delete-auto-user-provisioning-rule

object

A resource-specific HATEOAS link.

update-auto-user-provisioning-rule

object

A resource-specific HATEOAS link.

condition

string

required

The following table describes the possible conditions for a rule.

Group Selection	Rule Condition	Description
This group	`{"user.groups":{"$eq":"Admin"}}`	User must belong to the specified group.
ANY of these groups	`{"user.groups":{"$in":["Admin", "Eng", "Sales"]}}`	A user must belong to at least one of the specified groups.
ALL of these groups	`{"user.groups":{"$all":["Admin", "Eng", "Sales"]}}`	A user must belong to all the specified groups.
Group CONTAINS this keyword	`{"user.groups":{"$contains":{"$in":["Admin"]}}}`	A user's group must contain the specified keyword.
Group CONTAINS ANY of these keywords	`{"user.groups":{"$contains":{"$in":["Admin", "Eng", "Sales"]}}}`	A user's group must contain at least one of the specified keywords.
Group CONTAINS ALL of these keywords	`{"user.groups":{"$contains":{"$all":["Admin", "Eng", "Sales"]}}}`	User's group must contain all the specified keywords.

name

string

required

Unique name assigned to the rule.

provision

object

required

Specifies the role and the organizational units to be assigned to the user subject to the rule criteria.

organizational_unit_ids

array of strings

required

The Clumio-assigned IDs of the organizational units to be assigned to the user. Use the GET /organizational-units endpoint to fetch valid values.

organizational_unit_ids*

role_id

string

required

The Clumio-assigned ID of the role to be assigned to the user. Use the GET /roles endpoint to fetch valid values.

rule_id

string

The Clumio-assigned ID of the rule.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us-west-2.api.clumio.com/settings/auto-user-provisioning/rules/rule_id \
3
     --header 'accept: application/api.clumio.auto-user-provisioning-rules=v1+json'


xxxxxxxxxx
29
}
1
{
2
  "_embedded": {},
3
  "_links": {
4
    "_self": {
5
      "href": "string",
6
      "templated": true,
7
      "type": "string"
8
    },
9
    "delete-auto-user-provisioning-rule": {
10
      "href": "string",
11
      "templated": true,
12
      "type": "string"
13
    },
14
    "update-auto-user-provisioning-rule": {
15
      "href": "string",
16
      "templated": true,
17
      "type": "string"
18
    }
19
  },
20
  "condition": "string",
21
  "name": "string",
22
  "provision": {
23
    "organizational_unit_ids": [
24
      "string"
25
    ],

200200 HTTP success response

defaultError