Jump to

• Request
• Response

listRoles

get

/ccadmin/v1/roles

List Roles. Get all roles for shoppers.

Request

Supported Media Types

• application/json

Query Parameters

• limit: string
  The maximum number of roles to be returned from this request.
• offset: string
  The starting offset/index to be returned from this request.
• preview: boolean
  If set to true, lists roles for preview users. Defaults to false.
• q: string
  Query string that filters the roles to be returned from this request using SCIM filtering syntax.
• sort: string
  The sort order of the list to be returned from this request.

Header Parameters

• X-CCAsset-Language: string
  The asset language of the request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listRoles_response

Type: object

Show Source

• items: array items
  All roles for internal users

{
    "properties":{
        "items":{
            "description":"All roles for internal users",
            "type":"array",
            "items":{
                "$ref":"#/definitions/getRole_response"
            }
        }
    }
}

Nested Schema : items

Type: array

All roles for internal users

Show Source

• Array of: object getRole_response

{
    "description":"All roles for internal users",
    "type":"array",
    "items":{
        "$ref":"#/definitions/getRole_response"
    }
}

Nested Schema : getRole_response

Type: object

Show Source

• accessRights: array accessRights
  Access rights assigned to role
• category: object category
  Category of the role
• description: string
  Description of role
• function: string
  Function name for organizationRole
• id: string
  ID of role
• name: string
  Name of role
• relativeTo: object relativeTo
  Related organization for organizationRole
• repositoryId: string
  Repository ID of role
• type: string
  Type of role (role or organizationalRole)

{
    "properties":{
        "function":{
            "description":"Function name for organizationRole",
            "type":"string"
        },
        "relativeTo":{
            "description":"Related organization for organizationRole",
            "type":"object",
            "properties":{
                "id":{
                    "description":"Repository ID of related organization",
                    "type":"string"
                },
                "externalOrganizationId":{
                    "description":"External organization id",
                    "type":"string"
                }
            }
        },
        "name":{
            "description":"Name of role",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of role",
            "type":"string"
        },
        "description":{
            "description":"Description of role",
            "type":"string"
        },
        "accessRights":{
            "description":"Access rights assigned to role",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"Display name of access right",
                        "type":"string"
                    },
                    "name":{
                        "description":"Name of access right",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Repository ID of access right",
                        "type":"string"
                    },
                    "description":{
                        "description":"Description of access right",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of access right",
                        "type":"string"
                    },
                    "type":{
                        "description":"Type of access right",
                        "type":"string"
                    }
                }
            }
        },
        "id":{
            "description":"ID of role",
            "type":"string"
        },
        "type":{
            "description":"Type of role (role or organizationalRole)",
            "type":"string"
        },
        "category":{
            "description":"Category of the role",
            "type":"object",
            "properties":{
                "displayName":{
                    "description":"Display name of the role category.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"Repository ID of the role category.(customRoleCategory or storefrontRoleCategory)",
                    "type":"string"
                },
                "id":{
                    "description":"ID of the role category.(customRoleCategory or storefrontRoleCategory)",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : accessRights

Type: array

Access rights assigned to role

Show Source

• Array of: object items

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

Nested Schema : category

Type: object

Category of the role

Show Source

• displayName: string
  Display name of the role category.
• id: string
  ID of the role category.(customRoleCategory or storefrontRoleCategory)
• repositoryId: string
  Repository ID of the role category.(customRoleCategory or storefrontRoleCategory)

{
    "description":"Category of the role",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Display name of the role category.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of the role category.(customRoleCategory or storefrontRoleCategory)",
            "type":"string"
        },
        "id":{
            "description":"ID of the role category.(customRoleCategory or storefrontRoleCategory)",
            "type":"string"
        }
    }
}

Nested Schema : relativeTo

Type: object

Related organization for organizationRole

Show Source

• externalOrganizationId: string
  External organization id
• id: string
  Repository ID of related organization

{
    "description":"Related organization for organizationRole",
    "type":"object",
    "properties":{
        "id":{
            "description":"Repository ID of related organization",
            "type":"string"
        },
        "externalOrganizationId":{
            "description":"External organization id",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

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

Example Response (application/json)

{
    "total":3,
    "totalResults":3,
    "offset":0,
    "limit":250,
    "items":[
        {
            "function":"accountAddressManager",
            "relativeTo":{
                "id":"or-100000",
                "externalOrganizationId":null
            },
            "name":"Account Address Manager",
            "repositoryId":"100001",
            "description":null,
            "id":"100001",
            "accessRights":[
                {
                    "displayName":null,
                    "name":"Create Account Address",
                    "repositoryId":"createAccountAddress",
                    "description":null,
                    "id":"createAccountAddress",
                    "type":"generic"
                },
                {
                    "displayName":null,
                    "name":"Update Account Address",
                    "repositoryId":"updateAccountAddress",
                    "description":null,
                    "id":"updateAccountAddress",
                    "type":"generic"
                }
            ],
            "type":"organizationalRole",
            "category":{
                "displayName":"Storefront Roles",
                "repositoryId":"storefrontRoleCategory",
                "id":"storefrontRoleCategory"
            }
        },
        {
            "function":"buyer",
            "relativeTo":{
                "id":"or-100000",
                "externalOrganizationId":null
            },
            "name":"Buyer",
            "repositoryId":"100002",
            "description":null,
            "id":"100002",
            "accessRights":[
            ],
            "type":"organizationalRole",
            "category":{
                "displayName":"Storefront Roles",
                "repositoryId":"storefrontRoleCategory",
                "id":"storefrontRoleCategory"
            }
        },
        {
            "name":"Custom Role",
            "repositoryId":"customRole",
            "description":"Custom Role",
            "id":"customRole",
            "accessRights":[
                {
                    "displayName":"Custom Access Right 1",
                    "name":"Custom Access Right 1",
                    "repositoryId":"customAccessRight1",
                    "description":"Custom Access Right 1",
                    "id":"customAccessRight1",
                    "type":"generic"
                }
            ],
            "type":"role",
            "category":{
                "displayName":"Custom Roles",
                "repositoryId":"customRoleCategory",
                "id":"customRoleCategory"
            }
        }
    ]
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "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: 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

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