---
title: "GetPermissions"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: EZGH Cloud organizations and IAM › policies

`GET /v1/organizations/{orgId}/permissions`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie
- `oauth`, http, header `Authorization`

## Path parameters

- `GetPermissions.path.orgId` (string, required)

## Query parameters

- `GetPermissions.query.actions` (string, optional)
- `GetPermissions.query.resource` (string, optional)

## Code samples

### cURL

```curl
curl --request GET \
  --url https://orgs.ezghcloud.com/v1/organizations/string/permissions \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://orgs.ezghcloud.com/v1/organizations/string/permissions';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://orgs.ezghcloud.com/v1/organizations/string/permissions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Success

#### Example

```json
{
  "organization": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "resourceName": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "isRoot": true
  },
  "principal": {
    "type": "user",
    "id": "string"
  },
  "apiKeyId": "string",
  "userIdentity": {
    "type": "Root",
    "principalId": "string",
    "userName": "string",
    "isRoot": true,
    "accessKeyId": "string",
    "sessionContext": {
      "credential": "session",
      "sessionIssuedAt": "string",
      "ssoProviderId": "string",
      "mfaAuthenticated": true,
      "clientId": "string"
    },
    "invokedBy": "string"
  },
  "resource": "string",
  "allowed": [
    "string"
  ],
  "allowedSomewhere": [
    "string"
  ]
}
```

- `GetPermissions.response.200.organization` (object, required)
  - `GetPermissions.response.200.organization.id` (string, required)
  - `GetPermissions.response.200.organization.name` (string, required)
  - `GetPermissions.response.200.organization.slug` (string, required)
  - `GetPermissions.response.200.organization.resourceName` (string, required)
  - `GetPermissions.response.200.organization.createdAt` (string, required)
  - `GetPermissions.response.200.organization.updatedAt` (string, required)
  - `GetPermissions.response.200.organization.isRoot` (boolean, required)
- `GetPermissions.response.200.principal` (object, required)
  - `GetPermissions.response.200.principal.type` (string, required)
    - one of `"user"`, `"bot"`
  - `GetPermissions.response.200.principal.id` (string, required)
- `GetPermissions.response.200.apiKeyId` (any of, required)
  - any of: `string`, `null`
- `GetPermissions.response.200.userIdentity` (object, required)
  - `GetPermissions.response.200.userIdentity.type` (string, required)
    - one of `"Root"`, `"User"`, `"Bot"`, `"EzghService"`, `"Unknown"`
  - `GetPermissions.response.200.userIdentity.principalId` (any of, required)
    - any of: `string`, `null`
  - `GetPermissions.response.200.userIdentity.userName` (any of, required)
    - any of: `string`, `null`
  - `GetPermissions.response.200.userIdentity.isRoot` (boolean, required)
  - `GetPermissions.response.200.userIdentity.accessKeyId` (any of, required)
    - any of: `string`, `null`
  - `GetPermissions.response.200.userIdentity.sessionContext` (any of, required)
    - any of: `object`, `null`
  - `GetPermissions.response.200.userIdentity.invokedBy` (any of, required)
    - any of: `string`, `null`
- `GetPermissions.response.200.resource` (string, required)
- `GetPermissions.response.200.allowed` (array<string>, required)
- `GetPermissions.response.200.allowedSomewhere` (array<string>, required)

### 400

InvalidRequest

#### Example

```json
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}
```

- `GetPermissions.response.400.error` (object, required)
  - `GetPermissions.response.400.error.code` (string, required)
    - one of `"invalid_request"`
  - `GetPermissions.response.400.error.message` (string, required)
  - `GetPermissions.response.400.error.issues` (array<object>, optional)
    - `GetPermissions.response.400.error.issues.path` (string, required)
    - `GetPermissions.response.400.error.issues.message` (string, required)

### 401

Unauthenticated

#### Example

```json
{
  "error": {
    "code": "unauthenticated",
    "message": "string"
  }
}
```

- `GetPermissions.response.401.error` (object, required)
  - `GetPermissions.response.401.error.code` (string, required)
    - one of `"unauthenticated"`
  - `GetPermissions.response.401.error.message` (string, required)

### 403

AccessDenied | ForbiddenOrigin

#### Example

```json
{
  "error": {
    "code": "access_denied",
    "message": "string"
  }
}
```

Any of:

- [AccessDeniedEncoded](/orgs-api/schemas/AccessDeniedEncoded/)
- [ForbiddenOriginEncoded](/orgs-api/schemas/ForbiddenOriginEncoded/)

### 404

NotFound

#### Example

```json
{
  "error": {
    "code": "not_found",
    "message": "string"
  }
}
```

- `GetPermissions.response.404.error` (object, required)
  - `GetPermissions.response.404.error.code` (string, required)
    - one of `"not_found"`
  - `GetPermissions.response.404.error.message` (string, required)

### 429

TooManyRequests

#### Example

```json
{
  "error": {
    "code": "too_many_requests",
    "message": "string"
  }
}
```

- `GetPermissions.response.429.error` (object, required)
  - `GetPermissions.response.429.error.code` (string, required)
    - one of `"too_many_requests"`
  - `GetPermissions.response.429.error.message` (string, required)

### 500

InternalError

#### Example

```json
{
  "error": {
    "code": "internal_error",
    "message": "string"
  }
}
```

- `GetPermissions.response.500.error` (object, required)
  - `GetPermissions.response.500.error.code` (string, required)
    - one of `"internal_error"`
  - `GetPermissions.response.500.error.message` (string, required)

### 503

Unavailable

#### Example

```json
{
  "error": {
    "code": "unavailable",
    "message": "string"
  }
}
```

- `GetPermissions.response.503.error` (object, required)
  - `GetPermissions.response.503.error.code` (string, required)
    - one of `"unavailable"`
  - `GetPermissions.response.503.error.message` (string, required)


Source: https://docs.ezghcloud.com/orgs-api/policies/GetPermissions/index.md