Roles

→

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

summary:

Retrieves a list of roles

Parameters:

Name	Type	Description	Required
fields	string	Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name	no
filters	string	Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws Server will be restricted to certain fields based on the indexed data for each resource.	no
orderBy	string	Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1	no
limit	integer	limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.	no
offset	integer	offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: OK
Response body:

{
  "items": [
    {
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "permissions": [
          "string"
        ],
        "scope": "string",
        "type": "string"
      },
      "status": {
        "isEnabled": "boolean"
      }
    }
  ]
}

→

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

summary:

Creates a role with specified permissions

Body

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "permissions": [
      "string"
    ],
    "scope": "string",
    "type": "string"
  },
  "status": {
    "isEnabled": "boolean"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/roles/{uid}

summary:

Deletes the specified role

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/roles/{uid}

summary:

Returns the specified role

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "permissions": [
      "string"
    ],
    "scope": "string",
    "type": "string"
  },
  "status": {
    "isEnabled": "boolean"
  }
}

→

https://api.spectrocloud.com/v1/roles/{uid}

summary:

Updates the specified role

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "permissions": [
      "string"
    ],
    "scope": "string",
    "type": "string"
  },
  "status": {
    "isEnabled": "boolean"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/roles/{uid}/clone

summary:

Clone the role

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "metadata": {
    "name": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

Edit on GitHub