GET
/api/apps/{app_id}AuthenticatedGet a client application
Loads one client application. Private apps are only visible to platform administrators, members of the owning organization, or the owning user.
operationId
get_api_apps_app_idClient applicationsAuthentication & permissionsAuthenticated
Any authenticated user
- Accepted credentials
- Auth server session (refresh token cookie)
cookie "refresh_token_<auth_server_app_id>" - Access token (cookie)
cookie "access_token_<auth_server_app_id>" - Access token (Bearer)
Authorization: Bearer <JWT>
- Auth server session (refresh token cookie)
- Who may call
- Any authenticated user
Path parameters
| Name | Type | Description |
|---|---|---|
| app_id* | string | Client application id |
Responses
application/json
| Property | Type | Description |
|---|---|---|
| success* | true | |
| app* | object | |
| app_id* | string | Client Application ID minLength: 2maxLength: 64pattern: ^[a-z0-9_-]*$ |
| app_name* | string | maxLength: 128 |
| app_description* | string | maxLength: 512 |
| created_at* | number | minimum: 0 |
| public* | boolean | |
| hardcoded* | boolean | |
| web* | boolean | |
| owner_type | "platform" | "organization" | "user" | "dynamic-client-registration" | |
| owner_organization_id | string | null | null | |
| owner_uid | string (uuid) | null (uuid) | null | |
| created_by | string (uuid) | null (uuid) | null | |
| client_uri | string (uri) | null (uri) | null | maxLength: 2048 |
| logo_uri | string (uri) | null (uri) | null | maxLength: 2048 |
| tos_uri | string (uri) | null (uri) | null | maxLength: 2048 |
| policy_uri | string (uri) | null (uri) | null | maxLength: 2048 |
| contacts | string[] | null | null | maxItems: 20 |
| grant_types | "authorization_code" | "refresh_token"[] | null | null | |
| response_types | "code"[] | null | null | |
| token_endpoint_auth_method | "none" | "client_secret_basic" | "client_secret_post" | null | null | |
| software_id | string | null | null | maxLength: 255 |
| software_version | string | null | null | maxLength: 255 |
| registered_scope | string | null | null | maxLength: 1024 |
| client_id_issued_at | integer | null | null | minimum: 0 |
JSONExample
"success"true
"app"
"app_id""string"
"app_name""string"
"app_description""string"
"created_at"1.5
"public"true
"hardcoded"true
"web"true
"owner_type""platform"
"owner_organization_id""string"
"owner_uid""123e4567-e89b-12d3-a456-426614174000"
"created_by""123e4567-e89b-12d3-a456-426614174000"
"client_uri""https://example.com"
"logo_uri""https://example.com"
"tos_uri""https://example.com"
"policy_uri""https://example.com"
"contacts"
"string"
"grant_types"
"authorization_code"
"response_types"
"code"
"token_endpoint_auth_method""none"
"software_id""string"
"software_version""string"
"registered_scope""string"
"client_id_issued_at"1
Example request
bashcurl
curl -X GET 'https://auth.schemavaults.com/api/apps/<app_id>' \
-b 'refresh_token_<auth_server_app_id>=<value>'