Get Loggedin User Organizations V2 Using GET

Get Loggedin User Organizations V2 Using GET

Get organizations of principal user.
Principal user is identified via a token. The token should be passed in a header called csp-auth-token.If expand parameter is passed, detailed information for the organizations will be returned.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
All Roles ✔️ ❌
Request
URI
GET
https://{api_host}/csp/gateway/am/api/v2/loggedin/user/orgs
COPY
Query Parameters
integer
pageStart
Optional
Constraints: minimum: 1 default: 1

Specifies the index that the set of results will begin with

integer
pageLimit
Optional
Constraints: minimum: 1 maximum: 200 default: 200

Specifies the maximum results per page for every call.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PagedResponseOrganizationDto of type(s) application/json 
{
    "prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
    "results": [
        {
            "language": "string",
            "displayName": "string",
            "name": "string",
            "maxAllowedAuthExemptedUserCount": 0,
            "customerId": "string",
            "refLink": "string",
            "type": "string",
            "parentRefLink": "string",
            "locale": "string",
            "trustedOrgs": [
                {
                    "displayName": "string",
                    "id": "string",
                    "trustType": "string"
                }
            ],
            "enforceUserApiTokenMfa": false,
            "trusteeOrgs": [
                {
                    "displayName": "string",
                    "id": "string",
                    "trustType": "string"
                }
            ],
            "auditLogsInstanceId": "string",
            "metadata": {
                "metadata": "string"
            },
            "isMfaRequired": false,
            "status": "string"
        }
    ],
    "totalResults": 2000,
    "nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15"
}
string
prevLink
Optional

Relative path to previous page if exists. Not returned for POST requests.

array of object
results
Optional

Partial list of returned results.

integer As int32 As int32
totalResults
Optional

Total number of results if available.

string
nextLink
Optional

Relative path to next page if exists. Not returned for POST requests.


400

Invalid request body

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

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 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


404

No user with given token exists

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

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 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/v2/loggedin/user/orgs
On This Page
Principal User Operations
GET
Get Loggedin User Organizations V2 Using GET
GET
Get Loggedin User Organizations Using GET
Deprecated
GET
Get Loggedin User Using GET
GET
Get Logged In User Roles On Organization By Organization Id Using GET
POST
Generate User Api Token Using POST
PUT
Set Default Organization Using PUT
Deprecated
GET
Get Logged In User Groups On Organization By Organization Id Using GET
GET
Get Logged In User Service Roles On Organization By Organization Id Using GET
GET
Get Logged In User Info Using GET