Skip to content
Authrim

List visible application launchers.

GET
/api/account/launchers
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/account/launchers \
  --cookie authrim_session=<authrim_session>

Returns enabled launchers whose user, group, or attribute audience matches the current account. Application identifiers, configured target URLs, and audience rules are omitted.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Visible application launchers and per-account favorite state.

Media type application/json
object
launchers
required
Array<object>
object
id
required
string
name
required
string
description
required
string | null
category
required
string | null
launch_type
required
string
Allowed values: bookmark saml_sp_initiated oidc_third_party_initiated saml_idp_initiated
open_in_new_tab
required
boolean
icon_type
required
string
Allowed values: phosphor image
icon_value
required
string
icon_color
required
string
background_color
required
string
grid_width
required
integer
>= 1 <= 8
sort_order
required
integer
enabled
required
boolean
allow_favorite
required
boolean
created_at
required
integer format: int64
updated_at
required
integer format: int64
favorite
required
boolean
launch_href
required
string
key
additional properties
Example 
{
  "launchers": [
    {
      "launch_type": "bookmark",
      "icon_type": "phosphor"
    }
  ]
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
error_code

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
error_code

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}