Updated on 2024-01-04 GMT+08:00

Canceling Authorization

Function

This API is used to cancel the authorization.

URI

  • URI format
    POST /ges/v1.0/{project_id}/graphs/{graph_name}/rbac/action?action_id=revoke
  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

    graph_name

    Yes

    String

    Graph name

Request

  • Request example
  • Request body parameter description
    Table 2 Request body parameter description

    Parameter

    Mandatory

    Type

    Description

    graph_name

    Yes

    String

    Graph name

    userId

    Yes

    String

    ID of the authorized user.

    acl

    Yes

    JsonArray

    Authorization details

    type

    Yes

    String

    Permission type. The value can be read, write, traverse, or schema.

    detail

    Yes

    JsonArray

    Permission details

    label

    Yes

    String

    Label name

    properties

    No

    List

    Properties

Response

  • Parameter description
    Table 3 Parameter description

    Parameter

    Mandatory

    Type

    Description

    errorMessage

    No

    String

    System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.

    errorCode

    No

    String

    System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.

  • Response example (successful request)
    Http Status Code: 200
  • Response example (failed request)
    Http Status Code: 400
    {
        "errorMessage": "grant acl is null",
        "errorCode": "GES.8503"
    }

Status Code

Response Code

Description

400 Bad Request

Request error.

401 Unauthorized

Authentication failed.

403 Forbidden

No operation permission.

404 Not Found

The requested resource was not found.

500 Internal Server Error

Internal service error.

503 Service Unavailable

Service unavailable.

Error Code

See Error Code.