FindsXXX regular users In one Of the identity providers configured for the tenant.

Below are the priorities for each search option:

if 'role' is set, find all users matching that role and return
else use 'criteria' to search either the account name, first name, last name, or description of the account. Filter results based on 'permissionFiltered' (if provided).

Parameters 'page', '$skip' and '$filter' are not taken into account. Use 'limit' and 'criteria' instead.

Request

URI

GET

https://{api_host}/identity/api/tenants/{tenantId}/principals

COPY

Path Parameters

string

tenantId

Required

the url of the tenant

Query Parameters

string

criteria

Optional

the search criteria

string

domain

Optional

the domain in which the service will search

string

parentGroup

Optional

the parent group id to search from

string

permissionFiltered

Optional

optional filter based on assigned status (either 'NOT_ASSIGNED' or 'ASSIGNED'

string

role

Optional

find users who have the provided role. All other search parameters ignored if this is set

boolean

expandGroups

Optional

If 'true' all child groups will be expanded and search

boolean

localUsersOnly

Optional

If 'true' only local users will be searched. Supported in Horizon mode only

integer

page

Optional

Page Number

integer

limit

Optional

Number of entries per page

string

$orderby

Optional

Multiple comma-separated properties sorted in ascending or descending order

integer

$top

Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer

$skip

Optional

Sets how many entries you would like to skip

string

$filter

Optional

Boolean expression for whether a particular entry should be included in the response

Responses

200

successful operation

Operation doesn't return any data structure

On This Page

Description

Request

Path Parameters

Query Parameters

Response

200 Response Body

Api Operations

PUT

Add A permission To A role extension

PUT

Add A permission To admin permissions

PUT

Add A scope role To A principal In the context Of A scope

POST

Add ACL To A tenant

POST

Add scope role(s) To A principal

PUT

Add System Or Tenant role To A principal

POST

Add users/grops To A parent group.

POST

Add Business Group Roles

PUT

Add Empty Admin Permission

PUT

Add Empty Permission

PUT

Add Empty Role Permission

PUT

Add Empty Scope Type Admin Permission

POST

Add Principals To Business Group Role

POST

Add Resources To Scope

PUT

Add Role Permission

PUT

Add Scope Type Admin Permission

GET

Check If A group exists.

POST

Create A custom group

POST

Create A local user.

PUT

Create Or update A principal extension

POST

Create Business Group

POST

Create Directory

DELETE

Delete A custom group

DELETE

Delete A local user.

DELETE

Delete A permission from admin permissions

DELETE

Delete A principal extension

DELETE

Delete A SSO group from A custom group

DELETE

Delete all principal extensions

Delete Business Group

Deletes the UserTokenResource associated with the provided principal.

DELETE

Deletes the UserTokenResource associated with the provided token id.

Find business groups Of A group

GET

Find users In groups

PUT

Find Principals From Business Group Role

GET

FindsXXX regular users In one Of the identity providers configured for the tenant.

GET

Get password policy for the passed tenant

GET

Get password state Of A local user

GET

Get Business Group

GET

Get Business Group Principal With Role

GET

Get Business Group Roles

Get Effective Permissions For Principal

GET

Get Permission Admin Permissions

GET

Get Role Admin Permissions

GET

Gets the group's advanced membership

GET

Get Tenant

GET

Get User Business Groups

PUT

DELETE

Remove A permission from A role extension

DELETE

Remove A user from A custom group

DELETE

Remove ACL entries from A tenant

DELETE

Remove An Scope role from A principal

DELETE

Remove Business Group Role

DELETE

Remove Empty Admin Permission

DELETE

Remove Empty Permission

DELETE

Remove Empty Principal Role

DELETE

Remove Empty Scope Role For Principal

DELETE

Remove Empty Scope Type Admin Permission

DELETE

Remove Principal From Business Group Role

DELETE

Remove Principal Role

DELETE

Remove Resource From Scope

DELETE

Remove Resources From Scope

DELETE

Remove Role Empty Permission

DELETE

Remove Role Permission

DELETE

Remove Scope Type Admin Permission

GET

Retrieve A group.

GET

Retrieve the status Of An identity store

GET

Retrieves all assigned custom groups and SSO groups.

GET

Retrieves all custom groups and SSO groups.

GET

Return A principal extension By Id

GET

Return A specific scope for principal

GET

Return A user

GET

Return ACL for A tenant

GET

Return admin permission for A scope type

GET

Return all parent groups

GET

Return all permissions Of A role

GET

Return business groups for A user

GET

Return parent groups Of A user

PUT

Return permissions for principals

PUT

Return roles for principals

GET

Return the effective roles for principal

PUT

Return the extended authorities for principals

PUT

Return the extended authorities permissions for principals

PUT

Return the extended authorities roles for principals

GET

Return the permissions assigned To A role

GET

Return the role extension assigned To A role

GET

Return the roles To assign To other users

GET

Return the scopes for principal

PUT

Return users By ids.

GET

Return Busines Groups Principal Roles

GET

Return Business Group Principals

PUT

Return Business Groups Principals

GET

Return Principal Extensions

PUT

Return Principal From Scopes

Returns A page Of the resources

GET

Returns A page Of the resources

GET

Returns A page Of the resources

GET

Returns A page Of the resources

GET

Returns A page Of the resources

POST

Returns A token associated with the provided credentials.

POST

Returns A token matching the provided request details.

GET

Returns the resource associated with the given Id

GET

Returns the resource associated with the given Id

GET

Returns the resource associated with the given Id

GET

Returns the resource associated with the given Id

GET

Returns the resource associated with the given Id

GET

Returns the UserSecurityContext associated with the provided token id.

Set scope role(s) To A principal

PUT

Set System and Tenant roles(s) To A principal

PUT

Set Resources To Scope

POST

Sets the group's advanced membership

POST

Sync Directory

PUT

Test the connectivity To An identity store

PUT

Update A custom group

PUT

Update A local user.

PUT

Update password policy for the passed tenant

PUT

Update service client secret

PUT

Update Business Group

PUT

Update Directory

PUT

Update Or Create Role Extension