Revoke roles from a group

PUT 
/metalakes/:metalake/permissions/groups/:group/revoke

Revokes roles from a group and returns the group with its remaining roles.

Sign in with a bearer token or a local user's password; see Authentication.

Request

Path Parameters

metalake stringrequired

The name of the metalake

group stringrequired

The name of the group

application/json

Body

roleNames string[]required

The role names need to revoke

Responses

200

The group, with the roles that remain after the revocation.

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

group

object

name stringrequired

The name of the group

roles string[]

The roles of the group

id int64

The identifier Gravitino assigns to the group

audit

object

Audit information for a Gravitino resource.

creator string

The user who created the resource

createTime date-time

The time the resource was created

lastModifier string

The user who last modified the resource

lastModifiedTime date-time

The time the resource was last modified

Example (from schema)

{
  "code": 0,
  "group": {
    "name": "string",
    "roles": [
      "string"
    ],
    "id": 0,
    "audit": {
      "creator": "string",
      "createTime": "2024-07-29T15:51:28.071Z",
      "lastModifier": "string",
      "lastModifiedTime": "2024-07-29T15:51:28.071Z"
    }
  }
}

GroupResponse

{
  "code": 0,
  "group": {
    "name": "group1",
    "roles": [],
    "audit": {
      "creator": "gravitino",
      "createTime": "2023-12-08T06:41:25.595Z"
    }
  }
}

400

One of the roles does not exist.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

IllegalRoleException

{
  "code": 1001,
  "type": "IllegalRoleException",
  "message": "Role role1 does not exist",
  "stack": [
    "org.apache.gravitino.exceptions.IllegalRoleException: Role role1 does not exist",
    "..."
  ]
}

404

The metalake or the group does not exist.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

NoSuchMetalakeException

{
  "code": 1003,
  "type": "NoSuchMetalakeException",
  "message": "Failed to operate metalake(s) [test] operation [LOAD], reason [NoSuchMetalakeException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchMetalakeException: Metalake test does not exist",
    "..."
  ]
}

NoSuchGroupException

{
  "code": 1003,
  "type": "NoSuchGroupException",
  "message": "Group does not exist",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchGroupException: Group does not exist",
    "..."
  ]
}

5xx

The server hit an internal error that the client usually cannot fix by changing the request.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...