Jump to

• Request
• Response

updateAdminAccessRight

put

/ccadmin/v1/adminAccessRights/{id}

Update Admin Access Right. Updates a given access right by ID.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The access right ID.

Body ()

Root Schema : updateAdminAccessRight_request

Type: object

Show Source

• description(optional): string
  Description of the access right
• displayName(optional): string
  Display name of the access right
• name: string
  Name of the access right
• repositoryId(optional): string
  Read Only: true

  Repository ID of the access right

{
    "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",
            "readOnly":true,
            "type":"string"
        },
        "description":{
            "description":"Description of the access right",
            "type":"string"
        }
    },
    "required":[
        "name"
    ],
    "example":{
        "displayName":"Sensitive Data",
        "name":"Sensitive Data",
        "description":"Access to sensitive data"
    }
}

Example:

{
    "displayName":"Sensitive Data",
    "name":"Sensitive Data",
    "description":"Access to sensitive data"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getAdminAccessRight_response

Type: object

Show Source

• category(optional): object category
• 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 the access right

{
    "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 the access right",
            "type":"string"
        },
        "category":{
            "type":"object",
            "properties":{
                "displayName":{
                    "description":"Display name of the access right category",
                    "type":"string"
                },
                "id":{
                    "description":"ID of the access right category",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : category

Type: object

Show Source

• displayName(optional): string
  Display name of the access right category
• id(optional): string
  ID of the access right category

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

Example Response (application/json)

{
    "displayName":"Sensitive Data",
    "name":"Sensitive Data",
    "repositoryId":"sensitiveData",
    "description":"Access to sensitive data",
    "id":"sensitiveData",
    "type":"generic",
    "category":{
        "displayName":"Custom",
        "id":"customAccessRightCategory"
    }
}

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| |------------------|------------------| |22052|If there was no access right found with the given id. Or if the input passed is invalid. Or if there was an internal error while updating the access right. Or if the user tried to update an access right of type privilege|

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