Jump to

• Request
• Response

listAccessRights

get

/ccadmin/v1/accessRights

List Access Rights. Get all access rights for shoppers.

Request

Supported Media Types

• application/json

Query Parameters

• limit: string
  The maximum number of access rights 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 access rights for preview users. Defaults to false.
• q: string
  Query string that filters the access rights 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 : listAccessRights_response

Type: object

Show Source

• items: array items
  All access rights for shoppers

{
    "properties":{
        "items":{
            "description":"All access rights for shoppers",
            "type":"array",
            "items":{
                "$ref":"#/definitions/getAccessRight_response"
            }
        }
    }
}

Nested Schema : items

Type: array

All access rights for shoppers

Show Source

• Array of: object getAccessRight_response

{
    "description":"All access rights for shoppers",
    "type":"array",
    "items":{
        "$ref":"#/definitions/getAccessRight_response"
    }
}

Nested Schema : getAccessRight_response

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

{
    "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":[
        {
            "displayName":"Custom Access Right 1",
            "name":"Custom Access Right 1",
            "repositoryId":"customAccessRight1",
            "description":"Custom Access Right 1",
            "id":"customAccessRight1",
            "type":"generic"
        },
        {
            "displayName":"Custom Access Right 2",
            "name":"Custom Access Right 2",
            "repositoryId":"customAccessRight2",
            "description":"Custom Access Right 2",
            "id":"customAccessRight2",
            "type":"generic"
        },
        {
            "displayName":"Custom Access Right 3",
            "name":"Custom Access Right 3",
            "repositoryId":"customAccessRight3",
            "description":"Custom Access Right 3",
            "id":"customAccessRight3",
            "type":"generic"
        }
    ]
}

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