Skip to main content

Create platform permission​

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

Request Body required
    bodies object[]
  • Array [
    • name string

    The name of the permission. It should be unique across a Frontier instance and can contain only alphanumeric characters.

    namespace namespace should be in service/resource format

    The namespace of the permission. The namespace should be in service/resource format.
    Example:compute/guardian

    metadata object

    The metadata object for permissions that can hold key value pairs.

    title string

    The title can contain any UTF-8 character, used to provide a human-readable name for the permissions. Can also be left empty.

    key key is composed of three parts, 'service.resource.verb'. Where 'service.resource' works as a namespace for the 'verb'. Use this instead of using name and namespace fields

    Permission path key is composed of three parts, 'service.resource.verb'. Where 'service.resource' works as a namespace for the 'verb'. Namespace name cannot be app as it's reserved for core permissions.

  • ]
Responses

A successful response.

Schema
    permissions object[]
  • Array [
    • id string
    name string
    title string
    createdAt date-time

    The time the permission was created.

    updatedAt date-time

    The time the permission was last updated.

    namespace string
    metadata object
    key string

    Permission path key is composed of three parts, 'service.resource.verb'. Where 'service.resource' works as a namespace for the 'verb'.

  • ]
POST /v1beta1/permissions

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL
http://127.0.0.1:7400
Security Scheme
Username
Password
Body required
{

  "bodies": [

    {

      "name": "string",

      "namespace": "string",

      "metadata": {},

      "title": "string",

      "key": "compute.instance.get"

    }

  ]

}
curl / cURL
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/permissions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "bodies": [
    {
      "name": "string",
      "namespace": "string",
      "metadata": {},
      "title": "string",
      "key": "compute.instance.get"
    }
  ]
}'