Roles

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

summary:
Retrieves a list of roles
Parameters:
NameTypeDescriptionRequired
fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
filtersstringFilters 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
orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
limitintegerlimit is a maximum number of responses to return for a list call. 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
continuestringcontinue token for the datasetno
200
OK
{
"items": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"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
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"permissions": [
"string"
],
"scope": "string",
"type": "string"
},
"status": {
"isEnabled": "boolean"
}
}
201
Created successfully
{
"uid": "string"
}

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

summary:
Returns the specified role
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"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:
NameTypeDescriptionRequired
uidstringyes
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"permissions": [
"string"
],
"scope": "string",
"type": "string"
},
"status": {
"isEnabled": "boolean"
}
}
204
The resource was updated successfully

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

summary:
Deletes the specified role
Path parameters:
NameTypeDescriptionRequired
uidstringyes
204
The resource was deleted successfully

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

summary:
Patches the specified role
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"items": {
"from": "string",
"op": "string",
"path": "string",
"value": "object"
}
}
204
The resource was updated successfully