Skip to main content

Find Roles

POST 
/groups-srv/graph/roles

This API call finds the roles using a graph filter to select the roles you want and limit the fields you would like to retrieve.

Filter Options:

  • object_ids: Array of role names to filter by (exact match). Maps to the role field.
  • object_owners: Array of role owners to filter by (exact match). Maps to the roleOwner field. Valid values: "client" or "admin".
  • from_date: Filter roles created on or after this date (ISO 8601 format).
  • to_date: Filter roles created on or before this date (ISO 8601 format).

Field Selection:

  • Use the fields parameter (space-separated string) to specify which fields to return
  • If fields is not specified, all fields are returned
  • Available fields: role, roleOwner, description, createdTime, updatedTime

Pagination:

  • Use from and size parameters for pagination
  • from: Starting index (default: 0)
  • size: Number of results to return

Sorting:

  • Use sortfield to specify the field to sort by (e.g., "role", "createdTime")
  • Use descending: true for descending order, false for ascending

Validation Rules:

  • object_ids: Optional array of strings, each must be a valid role name
  • object_owners: Optional array, must contain "client" or "admin"
  • from must be a non-negative integer
  • size must be a positive integer
  • from_date and to_date must be valid ISO 8601 date-time strings

Request​

Responses​

OK - Roles found matching the filter criteria