API Reference
  1. Lidia Identity
  2. Query > Roles > Roles

GetRoles

post
https://{yourLidiaUrl}/identity/query/roles

Retrieves resources matching the specified criteria.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The query containing filter parameters.

roleIds
array | null

Gets or sets the role ids.

roleIds
includeRoleIds
array of strings | null

Gets or sets the include role ids.

includeRoleIds
types
array of objects | null

Gets or sets the types.

types
sourceRoleCodes
array of strings | null

Gets or sets the source role codes.

sourceRoleCodes
roleNames
array of strings | null

Gets or sets the role names.

roleNames
includeRoleNames
array of strings | null

Gets or sets the include role names.

includeRoleNames
includeDescriptions
array of strings | null

Gets or sets the include descriptions.

includeDescriptions
environments
array of objects | null

Gets or sets the environments.

environments
Allowed:
applicationComponentIds
array | null

Gets or sets the application component ids.

applicationComponentIds
string | null

Gets or sets the environment.

string | null

Gets or sets the application i p.

string | null

Gets or sets the user token.

string | null

Gets or sets the unique identifier of the session id.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the unique identifier of the user id.

string | null

Gets or sets the user i p.

string | null

Gets or sets the envelope.

string | null

Gets or sets the unique identifier of the thread id.

includes
array of strings | null

Gets or sets the includes.

includes
string | null

Gets or sets the search key.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the page index.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the page size.

string | null

Gets or sets the sorting.

status
array of objects | null

Gets or sets the status.

status
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Response

Updated 18 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 18 days ago

Did this page help you?