Skip to content
Authrim

List launcher editor options.

GET
/api/admin/launchers/options
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/launchers/options \
  --header 'Authorization: Bearer <token>'

Returns OIDC clients, groups, known attribute keys, and supported Phosphor icon names.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Launcher editor options.

Media type application/json
object
oidc_clients
required
Array<object>
object
client_id
required
string
client_name
required
string
initiate_login_uri
required
string | null format: uri
logo_uri
required
string | null format: uri
key
additional properties
groups
required
Array<object>
object
id
required
string
group_key
required
string
display_name
required
string
key
additional properties
attribute_keys
required
Array<string>
phosphor_icons
required
Array<string>
key
additional properties
Example generated
{
  "oidc_clients": [
    {
      "client_id": "example",
      "client_name": "example",
      "initiate_login_uri": "https://example.com",
      "logo_uri": "https://example.com"
    }
  ],
  "groups": [
    {
      "id": "example",
      "group_key": "example",
      "display_name": "example"
    }
  ],
  "attribute_keys": [
    "example"
  ],
  "phosphor_icons": [
    "example"
  ]
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}