Retrieve a rule

Returns a representation of the specified auto user provisioning rule.

Path Parameters

rule_id string required
Retrieves the rule with the specified ID.

Responses

200
default

Success

application/api.clumio.auto-user-provisioning-rules=v1+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
read-organizational-unit
Embeds the associated organizational units for the OU UUIDs in the response if requested using the embed query parameter.
read-role ReadRoleEmbedded.
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.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
delete-auto-user-provisioning-rule object
A resource-specific HATEOAS link.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
update-auto-user-provisioning-rule object
A resource-specific HATEOAS link.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.

condition string

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"]}}`	User must belong to at least one of the specified groups.
ALL of these groups	`{"user.groups":{"$all":["Admin", "Eng", "Sales"]}}`	User must belong to all the specified groups.
Group CONTAINS this keyword	`{"user.groups":{"$contains":{"$in":["Admin"]}}}`	User's group must contain the specified keyword.
Group CONTAINS ANY of these keywords	`{"user.groups":{"$contains":{"$in":["Admin", "Eng", "Sales"]}}}`	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
Unique name assigned to the rule.
provision object
Specifies the role and the organizational units to be assigned to the user subject to the rule criteria.
organizational_unit_ids string[]
The Clumio-assigned IDs of the organizational units to be assigned to the user. Use the GET /organizational-units endpoint to fetch valid values.
role_id string
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.

{
  "_embedded": {},
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "delete-auto-user-provisioning-rule": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "update-auto-user-provisioning-rule": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "condition": "string",
  "name": "string",
  "provision": {
    "organizational_unit_ids": [
      "string"
    ],
    "role_id": "string"
  },
  "rule_id": "string"
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

Retrieve a rule​

Retrieve a rule