Skip to main content

get-resource-permission

restish dci get-resource-permission resourceType resourceId

Returns the permissions associated with the specified Cloud Analytics resource. Supports Attributions, Attributions Groups, Alerts, Budgets, and Reports.

Responses

200 (application/json)

OK - Resource permissions returned.

{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Resource id."
},
"name": {
"type": "string",
"description": "Resource name."
},
"description": {
"type": "string",
"description": "Resource description."
},
"createTime": {
"type": "integer",
"description": "The time when this resource was created, in milliseconds since the epoch.",
"format": "int64"
},
"updateTime": {
"type": "integer",
"description": "The time when this resource was last updated, in milliseconds since the epoch.",
"format": "int64"
},
"permissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"user": {
"type": "string",
"description": "The email address of the user to whom the role is assigned."
},
"role": {
"type": "string",
"description": "The role assigned to the user, defining their level of access to the resource.",
"enum": [
"owner",
"editor",
"viewer"
]
}
}
}
},
"public": {
"type": "string",
"description": "Type of permissions users in the entire organization have for this resource",
"enum": [
"editor",
"viewer"
],
"nullable": true
}
}
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Detailed error message."
}
}
}

401 (application/json)

Unauthorized - Invalid API key.

{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Detailed error message."
}
}
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Detailed error message."
}
}
}

404 (application/json)

Not Found - The requested resource does not exist.

{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Detailed error message."
}
}
}

500 (application/json)

Internal Server Error - Something went wrong with the DoiT API server.

{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Detailed error message."
}
}
}

Aliases: get-resource-permission, getresourcepermission