admin-service-create-permission.api.mdx

id	title	description	sidebar_label	hide_title	hide_table_of_contents	api	sidebar_class_name	info_path	custom_edit_url
admin-service-create-permission	Create permission	Creates a permission. It can be used to grant permissions to all the resources in a Shield instance.	Create permission	true	true	description operationId responses requestBody tags method path servers jsonRequestBodyExample info postman Creates a permission. It can be used to grant permissions to all the resources in a Shield instance. AdminService_CreatePermission 200 400 401 403 404 500 default description content A successful response. application/json schema type properties object permissions type items array type properties object id name title createdAt updatedAt namespace metadata type string type string type string type format string date-time type format string date-time type string 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 content required application/json schema type properties object bodies type items array type properties required object name namespace metadata title type description string The name of the permission. It should be unique across a Shield instance and can contain only alphanumeric characters. type description title string The namespace of the permission.The namespace should be in service/resource format.<br/>*Example:*`app/guardian` namespace should be in service/resource format type description object The metadata object for permissions that can hold key value pairs. type description string The title can contain any UTF-8 character, used to provide a human-readable name for the permissions. Can also be left empty. name namespace true Permission post /v1beta1/permissions url http://127.0.0.1:7400 bodies name namespace metadata title string string string 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 body Create permission content type Creates a permission. It can be used to grant permissions to all the resources in a Shield instance. text/plain path host query variable v1beta1 permissions {{baseUrl}} key value Content-Type application/json key value Accept application/json POST mode raw options raw "" raw language json	post 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";

Create permission

Creates a permission. It can be used to grant permissions to all the resources in a Shield instance.

<TabItem label={"application/json"} value={"application/json-schema"}>

<summary style={{"textAlign":"left"}}>Request Body<strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required<div style={{"textAlign":"left","marginLeft":"1rem"}}><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}>

bodies<span style={{"opacity":"0.6"}}> object[]

<div style={{"marginLeft":"1rem"}}>

<div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [

<SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the permission. It should be unique across a Shield instance and can contain only alphanumeric characters."}}><SchemaItem collapsible={false} name={"namespace"} required={true} schemaName={"namespace should be in service/resource format"} qualifierMessage={undefined} schema={{"type":"string","description":"The namespace of the permission.The namespace should be in service/resource format.
Example:app/guardian","title":"namespace should be in service/resource format"}}><SchemaItem collapsible={false} name={"metadata"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"The metadata object for permissions that can hold key value pairs."}}><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The title can contain any UTF-8 character, used to provide a human-readable name for the permissions. Can also be left empty."}}>

<div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]

<TabItem label={"200"} value={"200"}>

A successful response.

Schema

permissions object[]
Array [
]

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 [
]