GET/api/appsAuthenticated

List client applications

Lists client applications selected by list_apps_query_type. Listing every app requires a platform administrator; listing an organization's apps requires membership of that organization (or administrator rights).

operationId get_api_appsClient applications

Authentication & 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>
Who may call: Any authenticated user

Query parameters

Name	Type	Description
list_apps_query_type	string	Which apps to list: "all" (platform administrators only), "public" (publicly listed apps), "authorized" (apps the caller has authorized), "org" (apps owned by `organization_id`; members only), "owned" (apps owned by the caller's account) or "accessible" (every app the caller can reach by ownership). Required; an unknown value is a 400.
organization_id	string	The organization whose apps to list; required with `list_apps_query_type=org`.

Responses

application/json

ListAppsQueryResponse

Property	Type	Description
success*	true
message*	string
list*	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

"message""string"

"list"

"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"

"grant_types"

"response_types"

"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' \
  -b 'refresh_token_<auth_server_app_id>=<value>'

Other methods on this path

POSTCreate a client application

Authentication & permissionsAuthenticated

Query parameters

Responses

200The selected apps

400Missing or unknown list_apps_query_type, a missing / malformed organization_id for the org query, or a malformed query string

401No valid session cookie, access token cookie or bearer access token was presented, or the token was revoked

403The account is disabled, or the credential is valid but not allowed to perform this operation

500Failed to list apps

Example request

Other methods on this path