Return Business Group Principals

Return Business Group Principals

Return a list of principals for the specified business group, optionally filtered by role name.

Request

URI

GET

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

COPY

Path Parameters

string

tenantId

Required

the id of the tenant

string

id

Required

the business group id

Query Parameters

string

criteria

Optional

the filtering criteria (optional)

string

role

Optional

the filtering role (optional)

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

Returns PagePrincipalData of type(s) */*

{
    "number": 0,
    "size": 0,
    "last": false,
    "numberOfElements": 0,
    "totalPages": 0,
    "content": [
        {
            "name": "string",
            "principalId": {
                "domain": "string",
                "name": "string"
            },
            "principalType": "string"
        }
    ],
    "first": false,
    "totalElements": 0
}

integer As int32 As int32

number

Optional

number

integer As int32 As int32

size

Optional

size

boolean

last

Optional

last

integer As int32 As int32

numberOfElements

Optional

numberOfElements

integer As int32 As int32

totalPages

Optional

totalPages

Sort

sort

Optional

sort

array of principalData

content

Optional

content

boolean

first

Optional

first

integer As int64 As int64

totalElements

Optional

totalElements

On This Page

Request

Path Parameters

Query Parameters

200 Response Body

Api Operations

Add A permission To A role extension

Add A permission To admin permissions

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

Add ACL To A tenant

Add scope role(s) To A principal

Add System Or Tenant role To A principal

Add users/grops To A parent group.

Add Business Group Roles

Add Empty Admin Permission

Add Empty Permission

Add Empty Role Permission

Add Empty Scope Type Admin Permission

Add Principals To Business Group Role

Add Resources To Scope

Add Role Permission

Add Scope Type Admin Permission

Check If A group exists.

Create A custom group

Create A local user.

Create Or update A principal extension

Create Business Group

Create Directory

Delete A custom group

Delete A local user.

Delete A permission from admin permissions

Delete A principal extension

Delete A SSO group from A custom group

Delete all principal extensions

Delete All Resources

Delete All Scopes

Delete Business Group

Delete Directory

Delete Resource

Deletes the UserTokenResource associated with the provided principal.

Deletes the UserTokenResource associated with the provided token id.

Find business groups Of A group

Find users In groups

Find Principals From Business Group Role

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

Get password policy for the passed tenant

Get password state Of A local user

Get Business Group

Get Business Group Principal With Role

Get Business Group Roles

Get Business Groups

Get Directories

Get Effective Permissions For Principal

Get Permission Admin Permissions

Get Role Admin Permissions

Gets the group's advanced membership

Get User Business Groups

Register Or update relying party

Remove A permission from A role extension

Remove A user from A custom group

Remove ACL entries from A tenant

Remove An Scope role from A principal

Remove Business Group Role

Remove Empty Admin Permission

Remove Empty Permission

Remove Empty Principal Role

Remove Empty Scope Role For Principal

Remove Empty Scope Type Admin Permission

Remove Principal From Business Group Role

Remove Principal Role

Remove Resource From Scope

Remove Resources From Scope

Remove Role Empty Permission

Remove Role Permission

Remove Scope Type Admin Permission

Retrieve A group.

Retrieve the status Of An identity store

Retrieves all assigned custom groups and SSO groups.

Retrieves all custom groups and SSO groups.

Return A principal extension By Id

Return A specific scope for principal

Return ACL for A tenant

Return admin permission for A scope type

Return all parent groups

Return all permissions Of A role

Return business groups for A user

Return parent groups Of A user

Return permissions for principals

Return roles for principals

Return the effective roles for principal

Return the extended authorities for principals

Return the extended authorities permissions for principals

Return the extended authorities roles for principals

Return the permissions assigned To A role

Return the role extension assigned To A role

Return the roles To assign To other users

Return the scopes for principal

Return users By ids.

Return Busines Groups Principal Roles

Return Business Group Principals

Return Business Groups Principals

Return Principal Extensions

Return Principal From Scopes

Return Resource

Return Resources

Returns A page Of the resources

Returns A page Of the resources

Returns A page Of the resources

Returns A page Of the resources

Returns A page Of the resources

Returns A token associated with the provided credentials.

Returns A token matching the provided request details.

Returns the resource associated with the given Id

Returns the resource associated with the given Id

Returns the resource associated with the given Id

Returns the resource associated with the given Id

Returns the resource associated with the given Id

Returns the UserSecurityContext associated with the provided token id.

Set ACL Of A tenant

Set scope role(s) To A principal

Set System and Tenant roles(s) To A principal

Set Resources To Scope

Sets the group's advanced membership

Test the connectivity To An identity store

Update A custom group

Update A local user.

Update password policy for the passed tenant

Update service client secret

Update Business Group

Update Directory

Update Or Create Role Extension

Update Permission

Update Resource

Update Resource Type

Update Scope Type