DescribeOrganizationPolicy
Describes an organization policy for a principal.
/api/org/v1/policies/{principal}
Path Parameters
principal
requiredA principal that is granted permissions to access resources.
- Schema
ResourceDescriptor
- Type
string
- Minimum Length 1
- Maximum Length 255
- Pattern
^[a-z-]+:[A-Z0-9]+$
- Schema
Query Parameters
This operation does not have query parameters.
Request Body
This operation does not have a request body.
Responses
200 Response
The information about the resource policy is returned.
- Schema
Policy
- Type
object
- Properties
principal
requiredThe principal to which the resource permissions are granted.
- Schema
ResourceDescriptor
- Schema
permissions
requiredA list of resource permissions.
- Type
array
- Items
A resource permission granted to the principal.
- Schema
ResourceRelation
- Schema
- Type
createdAt
requiredThe time when the earliest permission was granted.
- Type
string
- Format
date-time
- Type
updatedAt
requiredThe time when the latest permission was granted.
- Type
string
- Format
date-time
- Type
400 Response
The requested operation cannot be performed because the request is malformed.
- Schema
Error
- Type
object
- Properties
message
requiredAn error message.
- Type
string
- Type
401 Response
The requested operation cannot be performed because the request lacks valid authentication credentials.
- Schema
Error
- Type
object
- Properties
message
requiredAn error message.
- Type
string
- Type
403 Response
The identity is not allowed to perform the requested operation for the resource involved.
- Schema
Error
- Type
object
- Properties
message
requiredAn error message.
- Type
string
- Type
404 Response
The resource or dependent resources involved in the requested operation do not exist.
- Schema
Error
- Type
object
- Properties
message
requiredAn error message.
- Type
string
- Type
Default Response
The requested operation failed with an error.
- Schema
Error
- Type
object
- Properties
message
requiredAn error message.
- Type
string
- Type