Jump to

• Request
• Response

getAdminRole

get

/ccadmin/v1/adminRoles/{id}

Get Admin Profile Role. Returns a role by ID.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The Admin Role ID.

Query Parameters

• expand(optional): string
  Expand query param: currently used to expand category information. Possible value for this query parameter is 'category'

  Allowed Values: [ "category" ]
• roleNotFoundError(optional): boolean
  This param is used to throw an error when role is not found. Defaults to true. Deprecated.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getAdminRole_response

Type: object

Show Source

• accessRights(optional): array accessRights
  Access rights assigned to the role
• category(optional): array category
  Category of the role
• description(optional): string
  Description 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 assigned to the role
• securityCriteriaLastModified(optional): string
  Security criteria last modified timestamp.

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

Nested Schema : accessRights

Type: array

Access rights assigned to the role

Show Source

• Array of: object items

{
    "description":"Access rights assigned to the role",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayName":{
                "description":"Display name of the access right",
                "type":"string"
            },
            "name":{
                "description":"Name of the access right",
                "type":"string"
            },
            "repositoryId":{
                "description":"Repository ID of the access right",
                "type":"string"
            },
            "description":{
                "description":"Description of the access right",
                "type":"string"
            },
            "id":{
                "description":"ID of the access right",
                "type":"string"
            },
            "type":{
                "description":"Type of 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"
            },
            "id":{
                "description":"ID of the role category.",
                "type":"string"
            }
        }
    }
}

Nested Schema : securityCriteria

Type: array

Security criteria assigned to the role

Show Source

• Array of: object items

{
    "description":"Security criteria assigned to the role",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"Name of the security criterion",
                "type":"string"
            },
            "description":{
                "description":"Description of the security criterion",
                "type":"string"
            },
            "id":{
                "description":"ID of the security criterion",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• description(optional): string
  Description of the access right
• displayName(optional): string
  Display name of the access right
• id(optional): string
  ID of the access right
• name(optional): string
  Name of the access right
• repositoryId(optional): string
  Repository ID of the access right
• type(optional): string
  Type of access right

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Display name of the access right",
            "type":"string"
        },
        "name":{
            "description":"Name of the access right",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of the access right",
            "type":"string"
        },
        "description":{
            "description":"Description of the access right",
            "type":"string"
        },
        "id":{
            "description":"ID of the access right",
            "type":"string"
        },
        "type":{
            "description":"Type of 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.

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

Nested Schema : items

Type: object

Show Source

• description(optional): string
  Description of the security criterion
• id(optional): string
  ID of the security criterion
• name(optional): string
  Name of the security criterion

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Name of the security criterion",
            "type":"string"
        },
        "description":{
            "description":"Description of the security criterion",
            "type":"string"
        },
        "id":{
            "description":"ID of the security criterion",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "securityCriteria":[
    ],
    "name":"Administrator",
    "repositoryId":"adminRole",
    "description":"Administrator Role",
    "id":"adminRole",
    "accessRights":[
        {
            "displayName":"Administrator",
            "name":"Administrator",
            "repositoryId":"ora.adminPrivilege",
            "description":"Administrator Privilege",
            "id":"ora.adminPrivilege",
            "type":"privilege"
        }
    ],
    "securityCriteriaLastModified":"2020-08-17T04:55:39.652Z",
    "category":"Administrator"
}

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| |------------------|------------------| |22049|If there was no role found with the given id|

Body ()

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"
        }
    }
}

Back to Top