REST API for Oracle Commerce Cloud 22A

getCurrentAdminProfile

get

/ccadmin/v1/adminProfiles/current

Get Current Admin Profile. Get the current profile information.

Request

Supported Media Types

application/json

Query Parameters

expand(optional): boolean

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" ]
includeAllowedActions(optional): boolean

If we want allowed actions for user, then pass true for this variable

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : getCurrentAdminProfile_response

Type: object

Show Source

accessRights(optional): array accessRights

Access rights of the user
active(optional): boolean

True if the user is active; false if the user is deactivated.
createdBy(optional): string

ID of the user that created this profile
email(optional): string

Email address and login name of the profile.
external(optional): boolean

True if the user was created externally
firstName(optional): string

First name of the profile.
id(optional): string

ID of this profile.
lastName(optional): string

Last name of the profile.
registrationDate(optional): string

User's registration date.
repositoryId(optional): string

Repository ID of this profile.
roles(optional): array roles

Array of roles assigned to this profile.
rolesLastModified(optional): string

Roles last modified timestamp.
tourComplete(optional): boolean

True if the user has completed the walk-through tour of the admin product.

{
    "properties":{
        "lastName":{
            "description":"Last name of the profile.",
            "type":"string"
        },
        "tourComplete":{
            "description":"True if the user has completed the walk-through tour of the admin product.",
            "type":"boolean"
        },
        "roles":{
            "description":"Array of roles assigned to this profile.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "securityCriteria":{
                        "description":"Security criteria of the role",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "repositoryId":{
                                    "description":"Repository ID of the security criteria.",
                                    "type":"string"
                                },
                                "name":{
                                    "description":"Name of the security criteria.",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"ID of the security criteria.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "repositoryId":{
                        "description":"Repository ID of the role.",
                        "type":"string"
                    },
                    "name":{
                        "description":"Name of the role.",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the role.",
                        "type":"string"
                    },
                    "accessRights":{
                        "description":"Access rights of the role",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "displayName":{
                                    "description":"Display name of the access right.",
                                    "type":"string"
                                },
                                "repositoryId":{
                                    "description":"Repository ID of the access right.",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"ID of the access right.",
                                    "type":"string"
                                },
                                "type":{
                                    "description":"Type of the access right.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "category":{
                        "description":"Category of the role",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "displayName":{
                                    "description":"Display name of the role category.",
                                    "type":"string"
                                },
                                "repositoryId":{
                                    "description":"Repository ID of the role category.",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"ID of the role category.",
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            }
        },
        "active":{
            "description":"True if the user is active; false if the user is deactivated.",
            "type":"boolean"
        },
        "firstName":{
            "description":"First name of the profile.",
            "type":"string"
        },
        "external":{
            "description":"True if the user was created externally",
            "type":"boolean"
        },
        "createdBy":{
            "description":"ID of the user that created this profile",
            "type":"string"
        },
        "registrationDate":{
            "description":"User's registration date.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of this profile.",
            "type":"string"
        },
        "accessRights":{
            "description":"Access rights of the user",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"Display name of the access right.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Repository ID of the access right.",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the access right.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Type of the access right.",
                        "type":"string"
                    }
                }
            }
        },
        "id":{
            "description":"ID of this profile.",
            "type":"string"
        },
        "rolesLastModified":{
            "description":"Roles last modified timestamp.",
            "type":"string"
        },
        "email":{
            "description":"Email address and login name of the profile.",
            "type":"string"
        }
    }
}

Nested Schema : accessRights

Type: array

Access rights of the user

Show Source

Array of: object items

{
    "description":"Access rights of the user",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayName":{
                "description":"Display name of the access right.",
                "type":"string"
            },
            "repositoryId":{
                "description":"Repository ID of the access right.",
                "type":"string"
            },
            "id":{
                "description":"ID of the access right.",
                "type":"string"
            },
            "type":{
                "description":"Type of the access right.",
                "type":"string"
            }
        }
    }
}

Nested Schema : roles

Type: array

Array of roles assigned to this profile.

Show Source

Array of: object items

{
    "description":"Array of roles assigned to this profile.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "securityCriteria":{
                "description":"Security criteria of the role",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "repositoryId":{
                            "description":"Repository ID of the security criteria.",
                            "type":"string"
                        },
                        "name":{
                            "description":"Name of the security criteria.",
                            "type":"string"
                        },
                        "id":{
                            "description":"ID of the security criteria.",
                            "type":"string"
                        }
                    }
                }
            },
            "repositoryId":{
                "description":"Repository ID of the role.",
                "type":"string"
            },
            "name":{
                "description":"Name of the role.",
                "type":"string"
            },
            "id":{
                "description":"ID of the role.",
                "type":"string"
            },
            "accessRights":{
                "description":"Access rights of the role",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "displayName":{
                            "description":"Display name of the access right.",
                            "type":"string"
                        },
                        "repositoryId":{
                            "description":"Repository ID of the access right.",
                            "type":"string"
                        },
                        "id":{
                            "description":"ID of the access right.",
                            "type":"string"
                        },
                        "type":{
                            "description":"Type of the access right.",
                            "type":"string"
                        }
                    }
                }
            },
            "category":{
                "description":"Category of the role",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "displayName":{
                            "description":"Display name of the role category.",
                            "type":"string"
                        },
                        "repositoryId":{
                            "description":"Repository ID of the role category.",
                            "type":"string"
                        },
                        "id":{
                            "description":"ID of the role category.",
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

displayName(optional): string

Display name of the access right.
id(optional): string

ID of the access right.
repositoryId(optional): string

Repository ID of the access right.
type(optional): string

Type of the access right.

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Display name of the access right.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of the access right.",
            "type":"string"
        },
        "id":{
            "description":"ID of the access right.",
            "type":"string"
        },
        "type":{
            "description":"Type of the access right.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

accessRights(optional): array accessRights

Access rights of the role
category(optional): array category

Category of the role
id(optional): string

ID of the role.
name(optional): string

Name of the role.
repositoryId(optional): string

Repository ID of the role.
securityCriteria(optional): array securityCriteria

Security criteria of the role

{
    "type":"object",
    "properties":{
        "securityCriteria":{
            "description":"Security criteria of the role",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository ID of the security criteria.",
                        "type":"string"
                    },
                    "name":{
                        "description":"Name of the security criteria.",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the security criteria.",
                        "type":"string"
                    }
                }
            }
        },
        "repositoryId":{
            "description":"Repository ID of the role.",
            "type":"string"
        },
        "name":{
            "description":"Name of the role.",
            "type":"string"
        },
        "id":{
            "description":"ID of the role.",
            "type":"string"
        },
        "accessRights":{
            "description":"Access rights of the role",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"Display name of the access right.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Repository ID of the access right.",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the access right.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Type of the access right.",
                        "type":"string"
                    }
                }
            }
        },
        "category":{
            "description":"Category of the role",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"Display name of the role category.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Repository ID of the role category.",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the role category.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : accessRights

Type: array

Access rights of the role

Show Source

Array of: object items

{
    "description":"Access rights of the role",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayName":{
                "description":"Display name of the access right.",
                "type":"string"
            },
            "repositoryId":{
                "description":"Repository ID of the access right.",
                "type":"string"
            },
            "id":{
                "description":"ID of the access right.",
                "type":"string"
            },
            "type":{
                "description":"Type of the access right.",
                "type":"string"
            }
        }
    }
}

Nested Schema : category

Type: array

Category of the role

Show Source

Array of: object items

{
    "description":"Category of the role",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayName":{
                "description":"Display name of the role category.",
                "type":"string"
            },
            "repositoryId":{
                "description":"Repository ID of the role category.",
                "type":"string"
            },
            "id":{
                "description":"ID of the role category.",
                "type":"string"
            }
        }
    }
}

Nested Schema : securityCriteria

Type: array

Security criteria of the role

Show Source

Array of: object items

{
    "description":"Security criteria of the role",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"Repository ID of the security criteria.",
                "type":"string"
            },
            "name":{
                "description":"Name of the security criteria.",
                "type":"string"
            },
            "id":{
                "description":"ID of the security criteria.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

displayName(optional): string

Display name of the access right.
id(optional): string

ID of the access right.
repositoryId(optional): string

Repository ID of the access right.
type(optional): string

Type of the access right.

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Display name of the access right.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of the access right.",
            "type":"string"
        },
        "id":{
            "description":"ID of the access right.",
            "type":"string"
        },
        "type":{
            "description":"Type of the access right.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

displayName(optional): string

Display name of the role category.
id(optional): string

ID of the role category.
repositoryId(optional): string

Repository ID of the role category.

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Display name of the role category.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of the role category.",
            "type":"string"
        },
        "id":{
            "description":"ID of the role category.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

id(optional): string

ID of the security criteria.
name(optional): string

Name of the security criteria.
repositoryId(optional): string

Repository ID of the security criteria.

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of the security criteria.",
            "type":"string"
        },
        "name":{
            "description":"Name of the security criteria.",
            "type":"string"
        },
        "id":{
            "description":"ID of the security criteria.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "lastName":"Admin",
    "tourComplete":true,
    "roles":[
        {
            "repositoryId":"adminRole"
        }
    ],
    "active":true,
    "firstName":"Amber",
    "external":false,
    "createdBy":"admin",
    "repositoryId":"iuser260015",
    "registrationDate":"2014-09-24T12:00:00.000Z",
    "id":"iuser260015",
    "rolesLastModified":"2021-02-22T12:00:00.000Z",
    "actions":[
        "worksetsAccess",
        "publishingAccess",
        "settingsTab",
        "mediaTab",
        "reportsTab"
    ],
    "email":"admin@example.com"
}

Default Response

The error response

Root Schema : errorModel

Type: object

Show Source

devMessage(optional): string

An optional non-localized message containing technical information for developers
errorCode(optional): string

The numerical code identifying the error
errors(optional): array errors

An optional list of errors if multiple errors were encountered
message(optional): string

The localized message describing the error
moreInfo(optional): string

An optional non-localized message with more information
o:errorPath(optional): string

An optional machine readable description of where the error occurred
status(optional): string

The HTTP status code
type(optional): string

The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

devMessage(optional): string

An optional non-localized message containing technical information for developers
errorCode(optional): string

The numerical code identifying the error
message(optional): string

The localized message describing the error
moreInfo(optional): string

An optional non-localized message with more information
o:errorPath(optional): string

An optional machine readable description of where the error occurred
status(optional): string

The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}