Creates a role with specified permissions

POST 
https://api.spectrocloud.com/v1/roles

Creates a role with specified permissions

Request

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name of the resource

uidstring

UID is the unique identifier generated for the resource. This is not an input field for any request.

Populated by the system. Read-only.

spec

Role specifications

permissionsstring[]

scopestring

Possible values: [system, tenant, project, resource]

typestring

Possible values: [system, user]

status

Role status

isEnabledboolean

Specifies if role account is enabled/disabled

Responses

201

Created successfully

Response Headers

• AuditUid

  string

  Audit uid for the request

application/json

Schema

Schema

uidstringrequired

Example (from schema)

{
  "uid": "string"
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X POST 'https://api.spectrocloud.com/v1/roles' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
--data-raw '{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-02T12:47:31.780Z",
    "deletionTimestamp": "2024-07-02T12:47:31.780Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-02T12:47:31.780Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "permissions": [
      "string"
    ],
    "scope": "system",
    "type": "system"
  },
  "status": {
    "isEnabled": true
  }
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

ProjectUid — header

Body

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-02T12:47:31.780Z",
    "deletionTimestamp": "2024-07-02T12:47:31.780Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-02T12:47:31.780Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "permissions": [
      "string"
    ],
    "scope": "system",
    "type": "system"
  },
  "status": {
    "isEnabled": true
  }
}