Skip to main content

List Rules​

Returns a list of auto user provisioning rules.

Query Parameters
  • limit int64

    Limits the size of the response on each page to the specified number of items.

  • start string

    Sets the page token used to browse the collection. Leave this parameter empty to get the first page. Other pages can be traversed using HATEOAS links.

  • filter string

    Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:

    FieldFilter ConditionDescription
    name$containsA case sensitive substring of the name of the rule.
    role_id$eqA Clumio-assigned ID of the role.
    organizational_unit_id$eqA Clumio-assigned ID of the organizational unit.
    For more information about filtering, refer to the Filtering section of this guide.
Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • items object[]

    A collection of requested items.

  • _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 SelectionRule ConditionDescription
    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.

  • _links object

    URLs to pages related to the resource.

  • _first object

    The HATEOAS link to the first page of results.

  • 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.

  • _next object

    The HATEOAS link to the next page of results.

  • 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.

  • _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.

  • create-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.

  • current_count int64

    The number of items listed on the current page.

  • limit int64

    The maximum number of items displayed per page in the response.

  • start string

    The page token used to get this response.

Loading...