Get User Info By User Id And Organization Id Using GET

Get User Info By User Id And Organization Id Using GET

Get user information for a specific organization.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Admin ✔️
Organization Owner ✔️
Request
URI
GET
https://{api_host}/csp/gateway/am/api/v2/users/{userId}/orgs/{orgId}/info
COPY
Path Parameters
string
userId
Required

The userId or user account identifier.

string
orgId
Required

Unique identifier (GUID) of the organization.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UserInfoDto of type(s) application/json
{
    "user": {
        "acct": "string",
        "address": "string",
        "city": "string",
        "company": "string",
        "country": "string",
        "countryCode": "string",
        "countryName": "string",
        "customerNumber": "string",
        "email": "string",
        "emailVerified": false,
        "eulaInfo": "string",
        "firstName": "string",
        "lastName": "string",
        "password": "string",
        "refLink": "string",
        "state": "string",
        "stateCode": "string",
        "stateName": "string",
        "tnc": false,
        "tradeId": "string",
        "userId": "string",
        "userProfile": {
            "alternativeEmail": "string",
            "customerNumber": "string",
            "defaultOrgId": "string",
            "isFederated": false,
            "language": "string",
            "linkedUserIdAccount": "string",
            "locale": "string"
        },
        "username": "string",
        "website": "string",
        "workPhone": "string",
        "zipcode": "string"
    },
    "userOrgInfo": [
        {
            "customRoles": [
                {
                    "createdBy": "string",
                    "createdDate": "string",
                    "expiresAt": 3609941597,
                    "lastUpdatedBy": "string",
                    "lastUpdatedDate": "string",
                    "membershipType": "string",
                    "name": "string",
                    "resource": "string"
                }
            ],
            "displayName": "string",
            "name": "string",
            "orgRoles": [
                {
                    "createdBy": "string",
                    "createdDate": "string",
                    "displayName": "string",
                    "expiresAt": 0,
                    "lastUpdatedBy": "string",
                    "lastUpdatedDate": "string",
                    "name": "string",
                    "organizationLink": "string",
                    "resource": "string",
                    "visible": false
                }
            ],
            "servicesDef": [
                {
                    "refLink": "string",
                    "roles": [
                        {
                            "createdBy": "string",
                            "createdDate": "string",
                            "expiresAt": 3609941597,
                            "lastUpdatedBy": "string",
                            "lastUpdatedDate": "string",
                            "membershipType": "string",
                            "name": "string",
                            "resource": "string"
                        }
                    ],
                    "serviceDisplayName": "string",
                    "serviceName": "string",
                    "serviceRoles": [
                        "string"
                    ]
                }
            ]
        }
    ]
}
user
Optional

user

userOrgInfo
Optional

The organization, service and custom roles of the user.


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

User not found | 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


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