[{"label":"Latest (v1.0)","version":"latest"}]
csp
Get User Info By User ID And Organization ID
DescriptionGet user information for a specific organization.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ❌ |
| Organization Owner | ✔️ | ❌ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/v2/users/{userId}/orgs/{orgId}/info
Path Parameters
Path Parameters
string
userId
Required
The userId or user account identifier.
Parameter Serialization Style:
simple Explode:false
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
simple Explode:false
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
UserInfoDto
of type 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": "DIRECT",
"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": "DIRECT",
"name": "string",
"resource": "string"
}
],
"serviceDisplayName": "string",
"serviceName": "string",
"serviceRoles": [
"string"
]
}
]
}
]
}
Errors
CspErrorResponse
401
The user is not authorized to use the API
CspErrorResponse
403
The user is forbidden to use the API
CspErrorResponse
404
User not found | Organization not found
CspErrorResponse
429
The user has sent too many requests
CspErrorResponse
500
An unexpected error has occurred while processing the request
Code Samples
cURL Command
curl https://{api_host}/csp/gateway/am/api/v2/users/{userId}/orgs/{orgId}/info
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner,org_admin
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
