Search Organization Users By Organization Id And Roles Search Term Using POST

Search Organization Users By Organization Id And Roles Search Term Using POST

Search all users 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 users found by these search criteria the result contains all users 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.
When filterResults flag is true the result is filtered by search parameters from the request: resource, resourceStartsWith and roles names.
In this case the result contains just the roles that match the search criteria.
Paginated results - by default start index of results is 1 and default number of search results per page is 200.
Searching access restricted to Organization Owners, Read-only operators and Service Owners (for organizations that have access to the service).

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Admin ✔️ ✔️
Organization Owner ✔️ ✔️
Project Admin ✔️ ✔️
Request
URI
POST
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/users/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
SearchUsersByRolesRequest of type(s) application/json
Required
{
    "excludeRoles": false,
    "expandProfile": false,
    "includeGroupIdsInRoles": false,
    "pageLimit": 0,
    "pageStart": 0,
    "resource": "string",
    "resourceStartsWith": "string",
    "rolesSearchTerm": {
        "customRoles": [
            {
                "roleName": "string"
            }
        ],
        "orgRoles": [
            {
                "roleName": "string"
            }
        ],
        "serviceRoles": [
            {
                "serviceDefinitionId": "string",
                "serviceRoles": [
                    {
                        "roleName": "string"
                    }
                ]
            }
        ]
    },
    "searchType": "string",
    "userSearchTerm": "string"
}
boolean
excludeRoles
Optional

Indicates if the response should exclude the roles of the user (default: false).

boolean
expandProfile
Optional

Indicates if the response should be expanded with the user profile (default: false).

boolean
includeGroupIdsInRoles
Optional

Indicates if the inherited roles in the response should indicate group information (default: false).

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

Defines the roles properties which are used for search.

string
searchType
Optional

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

Possible values are : EXACT_MATCH, CONTAINS, STARTS_WITH, ENDS_WITH,
string
userSearchTerm
Optional

The string to be searched within email or firstName or lastName or username.Max search length is 120 characters. If it contains space separated terms, then the searchTerm is matched against possible firstName and lastName combinations. This search term is case insensitive.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PagedPostResponseExpandedTypedUserDto 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"
                }
            ],
            "orgId": "string",
            "organizationRoles": [
                {
                    "createdBy": "string",
                    "createdDate": "string",
                    "displayName": "string",
                    "expiresAt": 3609941597,
                    "groupIds": [
                        "string"
                    ],
                    "groups": [
                        {
                            "description": "string",
                            "displayName": "string",
                            "domain": "string",
                            "groupType": "string",
                            "id": "string",
                            "ownerOrgId": "string",
                            "sharedOrgIds": [
                                "string"
                            ],
                            "usersCount": 0
                        }
                    ],
                    "lastUpdatedBy": "string",
                    "lastUpdatedDate": "string",
                    "membershipType": "string",
                    "name": "string",
                    "resource": "string"
                }
            ],
            "serviceRoles": [
                {
                    "serviceDefinitionId": "string",
                    "serviceRoleNames": [
                        "string"
                    ],
                    "serviceRoles": [
                        {
                            "createdBy": "string",
                            "createdDate": "string",
                            "expiresAt": 3609941597,
                            "groupIds": [
                                "string"
                            ],
                            "groups": [
                                {
                                    "description": "string",
                                    "displayName": "string",
                                    "domain": "string",
                                    "groupType": "string",
                                    "id": "string",
                                    "ownerOrgId": "string",
                                    "sharedOrgIds": [
                                        "string"
                                    ],
                                    "usersCount": 0
                                }
                            ],
                            "lastUpdatedBy": "string",
                            "lastUpdatedDate": "string",
                            "membershipType": "string",
                            "name": "string",
                            "resource": "string"
                        }
                    ]
                }
            ],
            "user": {
                "accessible": false,
                "acct": "string",
                "domain": "string",
                "email": "string",
                "firstName": "string",
                "idpId": "string",
                "lastName": "string",
                "userId": "string",
                "userProfile": {
                    "alternativeEmail": "string",
                    "language": "string",
                    "locale": "string"
                },
                "username": "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

At least one role search term must be specified

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 with this identifier is 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


Organization Operations
POST
Activate Organization Refresh Tokens Using POST
Deprecated
POST
Activate Organization Refresh Tokens With Api Token Path Using POST
POST
Assign Roles To Clients On Organization Using POST
POST
Create Trust Member Organization Using POST
POST
Deactivate Organization Refresh Tokens Using POST
Deprecated
POST
Deactivate Organization Refresh Tokens With Api Token Path Using POST
DELETE
Delete Organization Idp Registration Using DELETE
GET
Get Groups In Organizations By Organization Id And Group Search Term Using GET
GET
Get Organization By Id Using GET
GET
Get Organization Clients By Organization Id Using GET
GET
Get Organization Invitations By Organization Id Using GET
GET
Get Organization Roles By Organization Id Using GET
GET
Get Organization Users By Organization Id Using GET
GET
Get Org Linked Idp Details Using GET
GET
Get Sub Organizations By Organization Id Using GET
GET
Get Trust Member Organizations Using GET
GET
Get User Invitation By Organization Id And User Invitation Id Using GET
GET
Get Users In Organization By Organization Id And User Search Term Using GET
Deprecated
POST
Invite Users Using POST
POST
Link Org To Idp Using POST
DELETE
Remove Clients From Organization By Organization Id Using DELETE
DELETE
Remove Users From Organization By Organization Id Using DELETE
DELETE
Revoke User Invitation By Organization Id And User Invitation Id Using DELETE
POST
Search Organization Users By Organization Id And Roles Search Term Using POST
PATCH
Update Organization By Organization Id Using PATCH