Get User In Any Organization
Use this API instead:
- /scim/v2/Users
Access Policy
| Role | Access |
|---|---|
| Platform operator | ✔️ |
| Organization Owner | ❌ |
| Organization Member | ❌ |
| Service Account (Whitelisted Client) | ✔️ |
Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/csp/gateway/am/api/v2/users/{userId}
COPY
Path Parameters
string
userId
Required
userId
Query Parameters
string
expandProfile
Optional
expandProfile
Responses
200
OK
Returns
UserByUserIdResponse
of type(s)
*/*
{
"id": "string",
"firstName": "string",
"lastName": "string",
"username": "string",
"acct": "string",
"password": "string",
"email": "string",
"refLink": "string",
"groups": [
"string"
],
"userProfile": {
"defaultOrgId": "string",
"isFederated": false,
"linkedUserIdAccount": "string",
"customerNumber": "string",
"locale": "string",
"language": "string"
},
"managerId": "string",
"idpUserDetails": {
"address": "string",
"city": "string",
"company": "string",
"country": "string",
"customerNumber": "string",
"workPhone": "string",
"zipCode": "string",
"state": "string"
}
}
string
id
Optional
id
string
firstName
Optional
firstName
string
lastName
Optional
lastName
string
username
Optional
username
string
acct
Optional
acct
string
password
Optional
password
string
email
Optional
string
refLink
Optional
refLink
array of
string
groups
Optional
groups
object
userProfile
Optional
userProfile
string
managerId
Optional
CSP user response doesn't contain managerId property.
object
idpUserDetails
Optional
idpUserDetails
401
The user is not authorized to use the API.
Returns
UserByUserIdResponse
of type(s)
*/*
"UserByUserIdResponse Object"
string
id
Optional
id
string
firstName
Optional
firstName
string
lastName
Optional
lastName
string
username
Optional
username
string
acct
Optional
acct
string
password
Optional
password
string
email
Optional
string
refLink
Optional
refLink
array of
string
groups
Optional
groups
object
userProfile
Optional
userProfile
string
managerId
Optional
CSP user response doesn't contain managerId property.
object
idpUserDetails
Optional
idpUserDetails
404
The user is not found.
Returns
UserByUserIdResponse
of type(s)
*/*
"UserByUserIdResponse Object"
string
id
Optional
id
string
firstName
Optional
firstName
string
lastName
Optional
lastName
string
username
Optional
username
string
acct
Optional
acct
string
password
Optional
password
string
email
Optional
string
refLink
Optional
refLink
array of
string
groups
Optional
groups
object
userProfile
Optional
userProfile
string
managerId
Optional
CSP user response doesn't contain managerId property.
object
idpUserDetails
Optional
idpUserDetails
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/v2/users/{userId}