---
title: "Get an application"
---

> 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 SSO API

`GET /v1/organizations/{orgId}/sso/applications/{appId}`

## Authentication

Requires one of the following:

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

## Path parameters

- `GetApplication.path.orgId` (string, required)
  - format `uuid`
- `GetApplication.path.appId` (string, required)
  - format `uuid`

## Code samples

### cURL

```curl
curl --request GET \
  --url https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/applications/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/applications/497f6eca-6276-4993-bfeb-53cbbbba6f08';
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://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/applications/497f6eca-6276-4993-bfeb-53cbbbba6f08"

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

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

print(response.text)
```

## Responses

### 200

The application.

#### Example

```json
{
  "createdAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18",
  "ezgh": {
    "consoleSessionSeconds": 900,
    "launchUrl": "http://example.com",
    "product": "mcpcentral",
    "resourceTokenLifetimeSeconds": 300
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "kind": "oidc",
  "logoUrl": "http://example.com",
  "managedBy": "string",
  "name": "string",
  "oidc": {
    "accessTokenAudience": "string",
    "accessTokenLifetimeSeconds": 300,
    "applicationType": "web",
    "backchannelLogoutUri": "http://example.com",
    "clientId": "string",
    "clientSecrets": [
      {
        "createdAt": "2019-08-24T14:15:22Z",
        "createdBy": {
          "id": "string",
          "type": "string"
        },
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "lastUsedAt": "2019-08-24T14:15:22Z",
        "prefix": "string"
      }
    ],
    "groupsClaim": "assigned",
    "idTokenSignedResponseAlg": "RS256",
    "initiateLoginUri": "http://example.com",
    "issuer": "http://example.com",
    "jwks": {},
    "jwksFetchError": "string",
    "jwksFetchedAt": "2019-08-24T14:15:22Z",
    "jwksUri": "http://example.com",
    "postLogoutRedirectUris": [
      "http://example.com"
    ],
    "redirectUris": [
      "http://example.com"
    ],
    "tokenEndpointAuthMethod": "client_secret_basic"
  },
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "projectId": null,
  "region": "string",
  "resourceName": "string",
  "saml": {
    "acsUrls": [
      "http://example.com"
    ],
    "attributes": [
      {
        "name": "string",
        "nameFormat": "unspecified",
        "value": "string"
      }
    ],
    "defaultRelayState": "string",
    "encryptAssertions": true,
    "encryptionAlgorithm": "aes128-gcm",
    "entityId": "string",
    "groupsFilter": "assigned",
    "idp": {
      "certificates": [
        {
          "activatesAt": "2019-08-24T14:15:22Z",
          "certificate": "string",
          "fingerprintSha256": "string",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "notAfter": "2019-08-24T14:15:22Z",
          "notBefore": "2019-08-24T14:15:22Z",
          "status": "active",
          "subject": "string",
          "warnAt": "2019-08-24T14:15:22Z"
        }
      ],
      "entityId": "string",
      "initiateUrl": "http://example.com",
      "metadataUrl": "http://example.com",
      "sloUrl": "http://example.com",
      "ssoUrl": "http://example.com"
    },
    "idpInitiated": true,
    "metadataImportedAt": "2019-08-24T14:15:22Z",
    "metadataUrl": "http://example.com",
    "nameIdFormat": "email",
    "signAssertion": true,
    "signResponse": true,
    "sloBinding": "HTTP-Redirect",
    "sloUrl": "http://example.com",
    "spCertificates": [
      {
        "certificate": "string",
        "fingerprintSha256": "string",
        "notAfter": "2019-08-24T14:15:22Z",
        "subject": "string",
        "use": "signing"
      }
    ]
  },
  "slug": "string",
  "status": "active",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z"
}
```

- `GetApplication.response.200.createdAt` (string, required)
  - format `date-time`
- `GetApplication.response.200.description` (string, required)
- `GetApplication.response.200.directoryId` (string, required)
  - format `uuid`
- `GetApplication.response.200.ezgh` (one of, required)
  - one of: [EzghSettings](/sso-api/schemas/EzghSettings/), `null`
- `GetApplication.response.200.id` (string, required)
  - format `uuid`
- `GetApplication.response.200.kind` (string, required)
  - one of `"oidc"`, `"ezgh"`, `"saml"`
- `GetApplication.response.200.logoUrl` (string | null, required) — Read-only: where sso-edge serves the application's uploaded logo (its portal tile's icon) on the directory's host, https://<alias>.sso.ezgh.app/branding/applications/<id>/logo?v=…, or null. A replaced logo is a new URL. Upload it with PUT …/applications/{appId}/logo; create and update refuse logoUrl.
  - format `uri`
- `GetApplication.response.200.managedBy` (string | null, required) — The EZGH product that manages this ezgh application through its own internal routes (MCP Central's, created when EZGH SSO is associated with it), or null. A managed application is read-only here: updating or deleting it, or changing its assignments, is 409 managed_by_product, and creating another ezgh application of its product in the directory is refused the same way.
- `GetApplication.response.200.name` (string, required)
- `GetApplication.response.200.oidc` (one of, required)
  - one of: [OidcSettings](/sso-api/schemas/OidcSettings/), `null`
- `GetApplication.response.200.organizationId` (string, required)
  - format `uuid`
- `GetApplication.response.200.projectId` (null, required)
- `GetApplication.response.200.region` (string, required)
- `GetApplication.response.200.resourceName` (string, required)
- `GetApplication.response.200.saml` (one of, required)
  - one of: [SamlSettings](/sso-api/schemas/SamlSettings/), `null`
- `GetApplication.response.200.slug` (string, required)
- `GetApplication.response.200.status` (string, required)
  - one of `"active"`
- `GetApplication.response.200.tags` (map<string>, required)
- `GetApplication.response.200.updatedAt` (string, required)
  - format `date-time`

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetApplication.response.400.error` (object, required)
  - `GetApplication.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetApplication.response.400.error.message` (string, required)
    - maxLength 1024
  - `GetApplication.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetApplication.response.400.error.issues.message` (string, required)
    - `GetApplication.response.400.error.issues.path` (string, required)
  - `GetApplication.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetApplication.response.400.error.quota.id` (string, required)
    - `GetApplication.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetApplication.response.400.error.quota.limit` (integer, required)
      - min 0
    - `GetApplication.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetApplication.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetApplication.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetApplication.response.400.error.quota.region` (string, optional)
    - `GetApplication.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetApplication.response.400.error.quota.scopeResourceName` (string, optional)
    - `GetApplication.response.400.error.quota.used` (integer, optional)
      - min 0
    - `GetApplication.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetApplication.response.401.error` (object, required)
  - `GetApplication.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetApplication.response.401.error.message` (string, required)
    - maxLength 1024
  - `GetApplication.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetApplication.response.401.error.issues.message` (string, required)
    - `GetApplication.response.401.error.issues.path` (string, required)
  - `GetApplication.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetApplication.response.401.error.quota.id` (string, required)
    - `GetApplication.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetApplication.response.401.error.quota.limit` (integer, required)
      - min 0
    - `GetApplication.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetApplication.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetApplication.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetApplication.response.401.error.quota.region` (string, optional)
    - `GetApplication.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetApplication.response.401.error.quota.scopeResourceName` (string, optional)
    - `GetApplication.response.401.error.quota.used` (integer, optional)
      - min 0
    - `GetApplication.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetApplication.response.403.error` (object, required)
  - `GetApplication.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetApplication.response.403.error.message` (string, required)
    - maxLength 1024
  - `GetApplication.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetApplication.response.403.error.issues.message` (string, required)
    - `GetApplication.response.403.error.issues.path` (string, required)
  - `GetApplication.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetApplication.response.403.error.quota.id` (string, required)
    - `GetApplication.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetApplication.response.403.error.quota.limit` (integer, required)
      - min 0
    - `GetApplication.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetApplication.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetApplication.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetApplication.response.403.error.quota.region` (string, optional)
    - `GetApplication.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetApplication.response.403.error.quota.scopeResourceName` (string, optional)
    - `GetApplication.response.403.error.quota.used` (integer, optional)
      - min 0
    - `GetApplication.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetApplication.response.404.error` (object, required)
  - `GetApplication.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetApplication.response.404.error.message` (string, required)
    - maxLength 1024
  - `GetApplication.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetApplication.response.404.error.issues.message` (string, required)
    - `GetApplication.response.404.error.issues.path` (string, required)
  - `GetApplication.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetApplication.response.404.error.quota.id` (string, required)
    - `GetApplication.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetApplication.response.404.error.quota.limit` (integer, required)
      - min 0
    - `GetApplication.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetApplication.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetApplication.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetApplication.response.404.error.quota.region` (string, optional)
    - `GetApplication.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetApplication.response.404.error.quota.scopeResourceName` (string, optional)
    - `GetApplication.response.404.error.quota.used` (integer, optional)
      - min 0
    - `GetApplication.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetApplication.response.429.error` (object, required)
  - `GetApplication.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetApplication.response.429.error.message` (string, required)
    - maxLength 1024
  - `GetApplication.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetApplication.response.429.error.issues.message` (string, required)
    - `GetApplication.response.429.error.issues.path` (string, required)
  - `GetApplication.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetApplication.response.429.error.quota.id` (string, required)
    - `GetApplication.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetApplication.response.429.error.quota.limit` (integer, required)
      - min 0
    - `GetApplication.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetApplication.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetApplication.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetApplication.response.429.error.quota.region` (string, optional)
    - `GetApplication.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetApplication.response.429.error.quota.scopeResourceName` (string, optional)
    - `GetApplication.response.429.error.quota.used` (integer, optional)
      - min 0
    - `GetApplication.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetApplication.response.500.error` (object, required)
  - `GetApplication.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetApplication.response.500.error.message` (string, required)
    - maxLength 1024
  - `GetApplication.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetApplication.response.500.error.issues.message` (string, required)
    - `GetApplication.response.500.error.issues.path` (string, required)
  - `GetApplication.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetApplication.response.500.error.quota.id` (string, required)
    - `GetApplication.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetApplication.response.500.error.quota.limit` (integer, required)
      - min 0
    - `GetApplication.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetApplication.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetApplication.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetApplication.response.500.error.quota.region` (string, optional)
    - `GetApplication.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetApplication.response.500.error.quota.scopeResourceName` (string, optional)
    - `GetApplication.response.500.error.quota.used` (integer, optional)
      - min 0
    - `GetApplication.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetApplication.response.503.error` (object, required)
  - `GetApplication.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetApplication.response.503.error.message` (string, required)
    - maxLength 1024
  - `GetApplication.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetApplication.response.503.error.issues.message` (string, required)
    - `GetApplication.response.503.error.issues.path` (string, required)
  - `GetApplication.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetApplication.response.503.error.quota.id` (string, required)
    - `GetApplication.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetApplication.response.503.error.quota.limit` (integer, required)
      - min 0
    - `GetApplication.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetApplication.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetApplication.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetApplication.response.503.error.quota.region` (string, optional)
    - `GetApplication.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetApplication.response.503.error.quota.scopeResourceName` (string, optional)
    - `GetApplication.response.503.error.quota.used` (integer, optional)
      - min 0
    - `GetApplication.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/sso-api/GetApplication/index.md
