Gets a policy

GET 
https://apis.<domain>/iam/policies/:id

Returns the details for a policy.

Authorization Action:

iam:policies:get

Request

Path Parameters

id stringrequired

ID of the policy.

Responses

200

A successful response.

application/json

Schema

Schema

policy object

namestring

Name for the policy.

idstring

Unique ID. Cannot be changed.

typecompiuta.api.iam.v2.Type (string)

Possible values: [COMPIUTA_MANAGED, CUSTOM]

Default value: COMPIUTA_MANAGED

membersstring[]

Members affected by this policy. May be empty.

statements object[]

Statements for the policy. Will contain one or more.

Array [

effectcompiuta.api.iam.v2.Statement.Effect (string)

Possible values: [ALLOW, DENY]

Default value: ALLOW

actionsstring[]

Actions defined inline. May be empty. Best practices recommend that you use custom roles rather than inline actions where practical.

rolestring

The role defines a set of actions that the statement is scoped to.

resourcesstring[]

Resources defined inline.

tenantsstring[]

The tenant list defines the set of resources that the statement is scoped to. May be empty.

]

tenantsstring[]

List of tenants this policy belongs to. May be empty.

Example (auto)

{
  "name": "My Viewer Policy",
  "id": "custom-viewer-policy",
  "members": [
    "team:local:*"
  ],
  "statements": [
    {
      "role": "viewer",
      "tenants": [
        "tenant1",
        "tenant2"
      ],
      "effect": "ALLOW"
    },
    {
      "role": "myRole",
      "tenants": [
        "exampleTenant"
      ],
      "effect": "ALLOW"
    }
  ],
  "tenants": []
}

default

An unexpected error response.

application/json

Schema

Schema

codeinteger<int32>
messagestring
details object[]
Array [
@typestring
property name*any
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://apis.<domain>/iam/policies/:id");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://apis.<domain>

Parameters

id — pathrequired