Skip to main content

Update platform permission​

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

Path Parameters
    id string required
Request Body required
    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
    permission object
    id string
    name string
    title string
    created_at date-time

    The time the permission was created.

    updated_at 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'.

PUT /v1beta1/permissions/:id

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
id — path required
Body required
{

  "name": "string",

  "namespace": "string",

  "metadata": {},

  "title": "string",

  "key": "compute.instance.get"

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