Search Organization Clients By Role Names Using POST

Search Organization Clients By Role Names Using POST

Search all clients who have at least one of the specified roles and/or resource.
Search by resource can be exact match or by resource starting with given term. At most one of the filters resource or resourceStartsWith may be provided.
For all clients found by these search criteria the result contains all clients roles, no matter if they are part of the search criteria or not.
To search by resource starting with given term provide resourceStartsWith.
If resource is empty then unscoped role assignments will be returned.
When role is provided and resource is null all role assignments will be returned.
Paginated results - by default start index of results is 1 and default number of search results per page is 15.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Admin ✔️
Organization Owner ✔️
Developer ✔️
Request
URI
POST
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/oauth-apps/search
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

Query Parameters
boolean
filterResults
Optional

Indicates if the response should be filtered by search parameters from the request: resource, resourceStartsWith and roles names (default: false).


Request Body
SearchClientsByRoleNamesRequest of type(s) application/json
Required
{
    "pageLimit": 0,
    "pageStart": 0,
    "resource": "string",
    "resourceStartsWith": "string",
    "rolesSearchTerm": {
        "customRoles": [
            {
                "roleName": "string"
            }
        ],
        "orgRoles": [
            {
                "roleName": "string"
            }
        ],
        "serviceRoles": [
            {
                "serviceDefinitionId": "string",
                "serviceRoles": [
                    {
                        "roleName": "string"
                    }
                ]
            }
        ]
    },
    "searchType": "string"
}
integer As int32 As int32
pageLimit
Optional

Maximum number to return in response. Default value is 200.

integer As int32 As int32
pageStart
Optional

Start index for querying. Default value is 1.

string
resource
Optional

Resource to search for resource-scoped role assignments.

string
resourceStartsWith
Optional

Resource to search for resource-scoped role assignments starting with given term. This field is deprecated. Consider using "resource" along with "searchType".

rolesSearchTerm
Optional

rolesSearchTerm

string
searchType
Optional

Defines the searching capability of the "resource" field value.

Possible values are : EXACT_MATCH, CONTAINS, STARTS_WITH, ENDS_WITH,
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PagedPostResponseExpandedAuthClientDto of type(s) application/json
{
    "itemsPerPage": 25,
    "results": [
        {
            "customRoles": [
                {
                    "createdBy": "string",
                    "createdDate": "string",
                    "expiresAt": 3609941597,
                    "lastUpdatedBy": "string",
                    "lastUpdatedDate": "string",
                    "membershipType": "string",
                    "name": "string",
                    "resource": "string"
                }
            ],
            "description": "string",
            "displayName": "string",
            "id": "string",
            "isHidden": false,
            "organizationRoles": [
                {
                    "createdBy": "string",
                    "createdDate": "string",
                    "displayName": "string",
                    "expiresAt": 3609941597,
                    "lastUpdatedBy": "string",
                    "lastUpdatedDate": "string",
                    "membershipType": "string",
                    "name": "string",
                    "resource": "string"
                }
            ],
            "serviceRoles": [
                {
                    "serviceDefinitionId": "string",
                    "serviceRoleNames": [
                        "string"
                    ],
                    "serviceRoles": [
                        {
                            "createdBy": "string",
                            "createdDate": "string",
                            "expiresAt": 3609941597,
                            "lastUpdatedBy": "string",
                            "lastUpdatedDate": "string",
                            "membershipType": "string",
                            "name": "string",
                            "resource": "string"
                        }
                    ]
                }
            ],
            "sourceOrg": {
                "displayName": "string",
                "orgId": "string",
                "shortId": "string"
            }
        }
    ],
    "startIndex": 5,
    "totalResults": 2000
}
integer As int32 As int32
itemsPerPage
Optional

Number of items per page.

results
Optional

Partial list of returned results.

integer As int32 As int32
startIndex
Optional

Start index of the results.

integer As int32 As int32
totalResults
Optional

Total number of results if available


400

Invalid request body

Returns CspErrorResponse of type(s) application/json
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


404

Organization not found

Returns CspErrorResponse of type(s) application/json
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


409

The request could not be processed due to a conflict

Returns CspErrorResponse of type(s) application/json
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode