admin-service-delete-role.api.mdx

id	title	description	sidebar_label	hide_title	hide_table_of_contents	api	sidebar_class_name	info_path	custom_edit_url
admin-service-delete-role	Delete platform role	Delete a platform wide role and all of its relations.	Delete platform role	true	true	description operationId responses parameters tags method path servers info postman Delete a platform wide role and all of its relations. AdminService_DeleteRole 200 400 401 403 404 500 default description content A successful response. application/json schema type object description content Bad Request - The request was malformed or contained invalid parameters. application/json schema type properties object code message details type format integer int32 type string type items array type properties additionalProperties object @type type string description content Unauthorized - Authentication is required application/json schema type properties object code message details type format integer int32 type string type items array type properties additionalProperties object @type type string description content Forbidden - User does not have permission to access the resource application/json schema type properties object code message details type format integer int32 type string type items array type properties additionalProperties object @type type string description content Not Found - The requested resource was not found application/json schema type properties object code message details type format integer int32 type string type items array type properties additionalProperties object @type type string description content Internal Server Error. Returned when theres is something wrong with Shield server. application/json schema type properties object code message details type format integer int32 type string type items array type properties additionalProperties object @type type string description content An unexpected error response. application/json schema type properties object code message details type format integer int32 type string type items array type properties additionalProperties object @type type string name description in required schema id The role id to delete. path true type string Role delete /v1beta1/roles/{id} url http://127.0.0.1:7400 title description version contact license Shield Administration API The Shield APIs adhere to the OpenAPI specification, also known as Swagger, which provides a standardized approach for designing, documenting, and consuming RESTful APIs. With OpenAPI, you gain a clear understanding of the API endpoints, request/response structures, and authentication mechanisms supported by the Shield APIs. By leveraging the OpenAPI specification, developers can easily explore and interact with the Shield APIs using a variety of tools and libraries. The OpenAPI specification enables automatic code generation, interactive API documentation, and seamless integration with API testing frameworks, making it easier than ever to integrate Shield into your existing applications and workflows. 0.2.0 name url email Open DataOps Foundation https://www.odpf.io/ hello@odpf.io name url Apache 2.0 https://github.com/odpf/shield/blob/main/LICENSE name description url header method Delete platform role content type Delete a platform wide role and all of its relations. text/plain path host query variable v1beta1 roles :id {{baseUrl}} disabled description type value key false content type (Required) The role id to delete. text/plain any id key value Accept application/json DELETE	delete api-method	apis/shield-administration-api

import ApiTabs from "@theme/ApiTabs"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import TabItem from "@theme/TabItem";

Delete platform role

Delete a platform wide role and all of its relations.

Path Parameters

A successful response.

Schema

object

Bad Request - The request was malformed or contained invalid parameters.

Schema

details object[]
Array [
]

Unauthorized - Authentication is required

Schema

details object[]
Array [
]

Forbidden - User does not have permission to access the resource

Schema

details object[]
Array [
]

Not Found - The requested resource was not found

Schema

details object[]
Array [
]

Internal Server Error. Returned when theres is something wrong with Shield server.

Schema

details object[]
Array [
]

An unexpected error response.

Schema

details object[]
Array [
]