/api/tenants/ {tenant Id} /principals

• Identity

Request

URI

POST

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

COPY

Path Parameters

string

tenantId

Required

tenantId

Query Parameters

string

page

Optional

page

string

limit

Optional

limit

string

$orderby

Optional

$orderby

string

$top

Optional

$top

string

$skip

Optional

$skip

string

$filter

Optional

$filter

string

criteria

Optional

criteria

string

domain

Optional

domain

string

parentGroup

Optional

parentGroup

string

permissionFiltered

Optional

permissionFiltered

string

role

Optional

role

string

expandGroups

Optional

expandGroups

string

localUsersOnly

Optional

localUsersOnly

string

page

Optional

page

string

limit

Optional

limit

string

$orderby

Optional

$orderby

string

$top

Optional

$top

string

$skip

Optional

$skip

string

$filter

Optional

$filter

string

criteria

Optional

criteria

string

domain

Optional

domain

string

parentGroup

Optional

parentGroup

string

permissionFiltered

Optional

permissionFiltered

string

role

Optional

role

string

expandGroups

Optional

expandGroups

string

localUsersOnly

Optional

localUsersOnly

---

Request Body

_api_softwarecomponenttypes__id_Body of type(s) application/json

Optional

Responses

default

Hide Details

Default response

Operation doesn't return any data structure

On This Page

Request

Path Parameters

Query Parameters

Request Body

Response

Errors

Identity Operations

POST

/api/authorization/permissions

GET

/api/authorization/permissions

PUT

/api/authorization/permissions/ {id}

DELETE

/api/authorization/permissions/ {id}

GET

/api/authorization/permissions/ {id}

PUT

/api/authorization/permissions/ {permission Id} /permissions/admin

DELETE

/api/authorization/permissions/ {permission Id} /permissions/admin

GET

/api/authorization/permissions/ {permission Id} /permissions/admin

PUT

/api/authorization/permissions/ {permission Id} /permissions/admin/ {admin Permission Id}

DELETE

/api/authorization/permissions/ {permission Id} /permissions/admin/ {admin Permission Id}

POST

/api/authorization/resource Types

GET

/api/authorization/resource Types

PUT

/api/authorization/resource Types/ {id}

DELETE

/api/authorization/resource Types/ {id}

GET

/api/authorization/resource Types/ {id}

POST

/api/authorization/roles

GET

/api/authorization/roles

GET

/api/authorization/roles/assignable

POST

/api/authorization/roles/extensions

GET

/api/authorization/roles/extensions

PUT

/api/authorization/roles/extensions/ {extension Id} /permissions/assigned

DELETE

/api/authorization/roles/extensions/ {extension Id} /permissions/assigned

PUT

/api/authorization/roles/extensions/ {extension Id} /permissions/assigned/ {permission Id}

DELETE

/api/authorization/roles/extensions/ {extension Id} /permissions/assigned/ {permission Id}

PUT

/api/authorization/roles/extensions/ {id}

DELETE

/api/authorization/roles/extensions/ {id}

GET

/api/authorization/roles/extensions/ {id}

PUT

/api/authorization/roles/ {id}

DELETE

/api/authorization/roles/ {id}

GET

/api/authorization/roles/ {id}

GET

/api/authorization/roles/ {role Id} /extensions

GET

/api/authorization/roles/ {role Id} /permissions

GET

/api/authorization/roles/ {role Id} /permissions/admin

PUT

/api/authorization/roles/ {role Id} /permissions/assigned

DELETE

/api/authorization/roles/ {role Id} /permissions/assigned

GET

/api/authorization/roles/ {role Id} /permissions/assigned

PUT

/api/authorization/roles/ {role Id} /permissions/assigned/ {permission Id}

DELETE

/api/authorization/roles/ {role Id} /permissions/assigned/ {permission Id}

POST

/api/authorization/scopes/types

GET

/api/authorization/scopes/types

PUT

/api/authorization/scopes/types/ {id}

DELETE

/api/authorization/scopes/types/ {id}

GET

/api/authorization/scopes/types/ {id}

PUT

/api/authorization/scopes/types/ {type Id} /permissions/admin

DELETE

/api/authorization/scopes/types/ {type Id} /permissions/admin

GET

/api/authorization/scopes/types/ {type Id} /permissions/admin

PUT

/api/authorization/scopes/types/ {type Id} /permissions/admin/ {admin Permission Id}

DELETE

/api/authorization/scopes/types/ {type Id} /permissions/admin/ {admin Permission Id}

PUT

/api/authorization/tenants/ {tenant Id} /acl

POST

/api/authorization/tenants/ {tenant Id} /acl

DELETE

/api/authorization/tenants/ {tenant Id} /acl

GET

/api/authorization/tenants/ {tenant Id} /acl

PUT

/api/authorization/tenants/ {tenant Id} /authorities/extended

PUT

/api/authorization/tenants/ {tenant Id} /authorities/extended/permissions

PUT

/api/authorization/tenants/ {tenant Id} /authorities/extended/roles

PUT

/api/authorization/tenants/ {tenant Id} /authorities/permissions

PUT

/api/authorization/tenants/ {tenant Id} /authorities/roles

POST

/api/authorization/tenants/ {tenant Id} /principals

DELETE

/api/authorization/tenants/ {tenant Id} /principals

GET

/api/authorization/tenants/ {tenant Id} /principals

PUT

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id}

DELETE

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id}

GET

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id}

GET

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id} /permissions

PUT

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id} /roles

DELETE

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id} /roles

GET

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id} /roles

PUT

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id} /roles/ {role Id}

DELETE

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id} /roles/ {role Id}

GET

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id} /scopes

GET

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id} /scopes/ {scope Id}

PUT

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id} /scopes/ {scope Id} /roles

POST

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id} /scopes/ {scope Id} /roles

DELETE

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id} /scopes/ {scope Id} /roles

PUT

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id} /scopes/ {scope Id} /roles/ {scope Role Id}

DELETE

/api/authorization/tenants/ {tenant Id} /principals/ {principal Id} /scopes/ {scope Id} /roles/ {scope Role Id}

POST

/api/authorization/tenants/ {tenant Id} /resources

DELETE

/api/authorization/tenants/ {tenant Id} /resources

GET

/api/authorization/tenants/ {tenant Id} /resources

PUT

/api/authorization/tenants/ {tenant Id} /resources/ {resource Id}

DELETE

/api/authorization/tenants/ {tenant Id} /resources/ {resource Id}

GET

/api/authorization/tenants/ {tenant Id} /resources/ {resource Id}

POST

/api/authorization/tenants/ {tenant Id} /scopes

DELETE

/api/authorization/tenants/ {tenant Id} /scopes

GET

/api/authorization/tenants/ {tenant Id} /scopes

PUT

/api/authorization/tenants/ {tenant Id} /scopes Principals

PUT

/api/authorization/tenants/ {tenant Id} /scopes/ {scope Id}

DELETE

/api/authorization/tenants/ {tenant Id} /scopes/ {scope Id}

GET

/api/authorization/tenants/ {tenant Id} /scopes/ {scope Id}

PUT

/api/authorization/tenants/ {tenant Id} /scopes/ {scope Id} /resources

POST

/api/authorization/tenants/ {tenant Id} /scopes/ {scope Id} /resources

DELETE

/api/authorization/tenants/ {tenant Id} /scopes/ {scope Id} /resources

DELETE

/api/authorization/tenants/ {tenant Id} /scopes/ {scope Id} /resources/ {resource Id}

POST

/api/data Service/data/ {class Id}/ {id}

POST

/api/data Service/list/ {class Id} /default

POST

/api/data Service/list/ {class Id} /types/ {type Filter}

GET

/api/data Service/schema/ {class Id} /default

POST

/api/data Service/schema/ {class Id} /default/update

POST

/api/data Service/schema/ {class Id} /default/ {field Id} /values

GET

/api/data Service/schema/ {class Id} /instances/ {id}

POST

/api/data Service/schema/ {class Id} /instances/ {id} /update

POST

/api/data Service/schema/ {class Id} /instances/ {id}/ {field Id} /values

GET

/api/data Service/schema/ {class Id} /types/ {type Filter}

POST

/api/data Service/schema/ {class Id} /types/ {type Filter} /update

POST

/api/data Service/schema/ {class Id} /types/ {type Filter}/ {field Id} /values

POST

/api/migration/status

GET

/api/migration/status

POST

/api/migration/tenants/ {tenant Id} /directory

POST

/api/migration/tenants/ {tenant Id} /status

GET

/api/migration/tenants/ {tenant Id} /status

PUT

/api/services/ {service Solution User Name}

PUT

/api/sso/branding/default

POST

/api/tenants

GET

/api/tenants

PUT

/api/tenants/solutions

PUT

/api/tenants/ {tenant Id}

DELETE

/api/tenants/ {tenant Id}

GET

/api/tenants/ {tenant Id}

PUT

/api/tenants/ {tenant Id} /custom Groups

POST

/api/tenants/ {tenant Id} /directories

GET

/api/tenants/ {tenant Id} /directories

PUT

/api/tenants/ {tenant Id} /directories/connectivity

PUT

/api/tenants/ {tenant Id} /directories/ {id}

DELETE

/api/tenants/ {tenant Id} /directories/ {id}

GET

/api/tenants/ {tenant Id} /directories/ {id}

GET

/api/tenants/ {tenant Id} /directories/ {id} /status

GET

/api/tenants/ {tenant Id} /display Context

PUT

/api/tenants/ {tenant Id} /external Id P

GET

/api/tenants/ {tenant Id} /external Id P

DELETE

/api/tenants/ {tenant Id} /external Id P/**

POST

/api/tenants/ {tenant Id} /groups

GET

/api/tenants/ {tenant Id} /groups

GET

/api/tenants/ {tenant Id} /groups/assigned

PUT

/api/tenants/ {tenant Id} /groups/ {group Id}

POST

/api/tenants/ {tenant Id} /groups/ {group Id}

DELETE

/api/tenants/ {tenant Id} /groups/ {group Id}

GET

/api/tenants/ {tenant Id} /groups/ {group Id}

GET

/api/tenants/ {tenant Id} /groups/ {group Id} /parents

GET

/api/tenants/ {tenant Id} /groups/ {group Id} /subtenants

DELETE

/api/tenants/ {tenant Id} /groups/ {parent Group Id} /groups/ {group Id}

GET

/api/tenants/ {tenant Id} /groups/ {parent Group Id} /users

DELETE

/api/tenants/ {tenant Id} /groups/ {parent Group Id} /users/ {user Id}

PUT

/api/tenants/ {tenant Id} /membership

PUT

/api/tenants/ {tenant Id} /principals

POST

/api/tenants/ {tenant Id} /principals

GET

/api/tenants/ {tenant Id} /principals

PUT

/api/tenants/ {tenant Id} /principals/ {principal Id}

DELETE

/api/tenants/ {tenant Id} /principals/ {principal Id}

GET

/api/tenants/ {tenant Id} /principals/ {user Id}

GET

/api/tenants/ {tenant Id} /principals/ {user Id} /groups

GET

/api/tenants/ {tenant Id} /principals/ {user Id} /subtenants

PUT

/api/tenants/ {tenant Id} /relyingparty

PUT

/api/tenants/ {tenant Id} /security Context

PUT

/api/tenants/ {tenant Id} /subtenants

POST

/api/tenants/ {tenant Id} /subtenants

GET

/api/tenants/ {tenant Id} /subtenants

PUT

/api/tenants/ {tenant Id} /subtenants/principals

PUT

/api/tenants/ {tenant Id} /subtenants/roles/ {scope Role Ref} /principals

PUT

/api/tenants/ {tenant Id} /subtenants/ {id}

DELETE

/api/tenants/ {tenant Id} /subtenants/ {id}

GET

/api/tenants/ {tenant Id} /subtenants/ {id}

GET

/api/tenants/ {tenant Id} /subtenants/ {id} /principals

GET

/api/tenants/ {tenant Id} /subtenants/ {id} /principals/ {principal Id} /roles

POST

/api/tenants/ {tenant Id} /subtenants/ {id} /roles

GET

/api/tenants/ {tenant Id} /subtenants/ {id} /roles

DELETE

/api/tenants/ {tenant Id} /subtenants/ {id} /roles/ {scope Role Ref}

POST

/api/tenants/ {tenant Id} /subtenants/ {id} /roles/ {scope Role Ref} /principals

GET

/api/tenants/ {tenant Id} /subtenants/ {id} /roles/ {scope Role Ref} /principals

DELETE

/api/tenants/ {tenant Id} /subtenants/ {id} /roles/ {scope Role Ref} /principals/ {principal Id}

POST

/api/tokens

DELETE

/api/tokens/principals/ {principal}

POST

/api/tokens/suite Token

DELETE

/api/tokens/ {token Id}

GET

/api/tokens/ {token Id} /security Context