getAdminProfile
get
/ccadmin/v1/adminProfiles/{id}
Get Admin Profile. Returns an admin profile by id.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
ID of the user profile to get.
Query Parameters
-
expand: string
Expand query param: comma separated values that can be used to expand profile's roles and access rights information. Possible values for this query parameter are 'roles' and 'accessRights'Allowed Values:
[ "roles", "accessRights" ]
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getAdminProfile_response
Type:
Show Source
object-
accessRights:
array accessRights
Access rights of the user
-
active:
boolean
True if the user is active; false if the user is deactivated.
-
createdBy:
string
ID of the user that created this profile
-
email:
string
Email address and login name of the profile.
-
external:
boolean
True if the user was created externally
-
firstName:
string
First name of the profile.
-
id:
string
ID of this profile.
-
lastName:
string
Last name of the profile.
-
registrationDate:
string
User's registration date.
-
repositoryId:
string
Repository ID of this profile.
-
roles:
array roles
Array of roles assigned to this profile.
-
rolesLastModified:
string
Roles last modified timestamp.
-
tourComplete:
boolean
True if the user has completed the walk-through tour of the admin product.
Nested Schema : items
Type:
Show Source
object-
displayName:
string
Display name of the access right.
-
id:
string
ID of the access right.
-
repositoryId:
string
Repository ID of the access right.
-
type:
string
Type of the access right.
Nested Schema : items
Type:
Show Source
object-
accessRights:
array accessRights
Access rights assigned to the role
-
category:
array category
Category of the role
-
id:
string
ID of the role.
-
name:
string
Name of the role.
-
repositoryId:
string
Repository ID of the role.
-
securityCriteria:
array securityCriteria
Security criteria assigned to the role
Nested Schema : items
Type:
Show Source
object-
displayName:
string
Display name of the access right.
-
id:
string
ID of the access right.
-
repositoryId:
string
Repository ID of the access right.
-
type:
string
Type of the access right.
Nested Schema : items
Type:
Show Source
object-
displayName:
string
Display name of the role category.
-
id:
string
ID of the role category.
-
repositoryId:
string
Repository ID of the role category.
Nested Schema : items
Type:
Show Source
object-
id:
string
ID of the security criteria.
-
name:
string
Name of the security criteria.
-
repositoryId:
string
Repository ID of the security criteria.
Example Response (application/json)
{
"lastName":"Admin",
"firstName":"Amber",
"external":false,
"tourComplete":true,
"createdBy":"admin",
"roles":[
{
"repositoryId":"adminRole"
}
],
"repositoryId":"iuser260015",
"registrationDate":"2014-09-24T12:00:00.000Z",
"active":true,
"id":"iuser260015",
"rolesLastModified":"2021-02-22T12:00:00.000Z",
"email":"admin@example.com"
}Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|22000|If the profile id passed is null or empty|
|22001|If there was any internal error while getting the profile|
|22002|If there was no profile found with the given id|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code