Skip to main content

Returns all Role resources.​

This endpoint returns all Role resources. Attributes to include in the response can be specified with the 'attributes' query parameter. Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. The core schema is urn:ietf:params:scim:schemas:sailpoint:1.0:Role.

Query Parameters
  • filter string

    Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.

    Example: filter=name eq "Data Analyst"

  • sortBy string

    Allows sorting the results by a resource's attributes.

    Example: sortBy="name"

  • sortOrder string

    Determines what order to sort results in.

    Example: sortOrder="descending"

  • startIndex integer

    Determines the starting index of the result set.

    Example: startIndex=1100

  • count integer

    Specifies the number of results per page.

    Example: count=10

  • attributes string

    The Role attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Role.

    Example: attributes=name,type,classifications

    The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a Role.

  • excludedAttributes string

    The Role attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Role.

    Example: excludedAttributes=permits,requirements,inheritance

    The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for a Role.

Responses

Returns all SCIM Role resources.

Schema
  • totalResults integer

    Number of Role resources returned

  • startIndex integer

    The starting index of the resource set list. Can be specified with startIndex query parameter.

  • schemas string[]

    SCIM Schema used for response.

  • Resources undefined[]
  • id string

    IIQ ID of the Role.

  • name string

    Unique name for the Role. This name MUST be unique across the entire set of Roles.

  • descriptions array

    A list of localized descriptions of the Role.

  • type object

    The type of the Role.

  • displayableName string

    Displayable name of the Role.

  • active boolean

    Flag to indicate this Role is enabled or active.

  • activationDate date-time

    The date the Role will turn from inactive/disabled to active/enabled.

  • deactivationDate date-time

    The date the Role will turn from active/enabled to inactive/disabled.

  • owner object

    The owner of the Role.

  • displayName string

    Display name of the Role owner.

  • value string

    ID of the Role owner.

  • $ref string

    URI reference of the Role owner resource.

  • inheritance array

    Parent Roles this role inherits from.

  • displayName string

    Display name of the parent Role.

  • value string

    ID of the parent Role.

  • $ref string

    URI reference of the parent Role resource.

  • requirements array

    Roles this role requires. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are required to support a business role.

  • displayName string

    Display name of the required Role.

  • value string

    ID of the required Role.

  • $ref string

    URI reference of the required Role resource.

  • permits array

    Roles this role permits. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are allowed to support a business role.

  • displayName string

    Display name of the permitted Role.

  • value string

    ID of the permitted Role.

  • $ref string

    URI reference of the permitted Role resource.

  • classifications array

    Classifications of this Role.

  • source string

    The source of the ObjectClassification.

  • effective boolean

    Flag indicating this is an effective Classification.

  • classification object

    Classification of this Object.

  • name string

    The name of the Classification.

  • displayName string

    The displayName of the Classification.

  • origin string

    The origin of the Classification.

  • type string

    The type of the Classification. This can be used to group Classifications in/across different origins.

  • meta

    Metadata of the SCIM resource.

  • created date-time

    Datetime this Role was created.

  • location string

    The location of the SCIM resource.

  • lastModified date-time

    Datetime the Role was last modified.

  • version string

    The version of the SCIM resource.

  • resourceType string

    The SCIM resource type.

  • schemas string[]

    The schemas involved in the SCIM resource.

Loading...