Update an application launcher.

PUT

/api/admin/launchers/{id}

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/launchers/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "application_type": "standalone", "application_id": "example", "name": "example", "description": "example", "category": "example", "launch_type": "bookmark", "launch_url": "https://example.com", "deep_link_url": "https://example.com", "open_in_new_tab": true, "icon_type": "phosphor", "icon_value": "example", "icon_color": "example", "background_color": "example", "grid_width": 1, "sort_order": 1, "enabled": true, "allow_favorite": true, "visibility": { "mode": "everyone", "attribute_match": "all", "user_ids": [ "example" ], "group_ids": [ "example" ], "attribute_rules": [ { "id": "example", "attribute_key": "example", "operator": "equals", "attribute_value": "example" } ] } }'

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Request Body ^required

Media type application/json

object

application_type

required

string

Allowed values: standalone oidc_client saml_sp

application_id

required

Referenced OIDC client or SAML service-provider identifier. Must be null when application_type is standalone.

string | null

<= 500 characters

name

required

string

>= 1 characters <= 120 characters

description

required

string | null

<= 1000 characters

category

required

string | null

<= 100 characters

launch_type

required

string

Allowed values: bookmark saml_sp_initiated oidc_third_party_initiated saml_idp_initiated

launch_url

required

string | null format: uri

deep_link_url

required

Optional target forwarded as target_link_uri for OIDC third-party initiated login or as RelayState for SAML IdP-initiated login. For SAML SP-initiated launch, include any application-specific destination in launch_url instead; this field must be null.

string | null format: uri

open_in_new_tab

required

boolean

icon_type

required

string

Allowed values: phosphor image

icon_value

required

string

>= 1 characters <= 2048 characters

icon_color

required

string

/^#[0-9A-Fa-f]{6}$/

background_color

required

string

/^#[0-9A-Fa-f]{6}$/

grid_width

required

integer

>= 1 <= 8

sort_order

required

integer

<= 1000000

enabled

required

boolean

allow_favorite

required

boolean

visibility

required

object

mode

required

string

Allowed values: everyone users groups attributes

attribute_match

required

string

Allowed values: all any

user_ids

required

Array<string>

<= 500 items unique items

group_ids

required

Array<string>

<= 500 items unique items

attribute_rules

required

Array<object>

<= 32 items

object

id

required

string

<= 100 characters

attribute_key

required

string

<= 128 characters

operator

required

string

Allowed values: equals not_equals contains starts_with ends_with exists

attribute_value

required

string | null

<= 500 characters

key

additional properties

key

additional properties

key

additional properties

Responses

200

Updated launcher.

Media type application/json

object

launcher

required

object

application_type

required

string

Allowed values: standalone oidc_client saml_sp

application_id

required

Referenced OIDC client or SAML service-provider identifier. Must be null when application_type is standalone.

string | null

<= 500 characters

name

required

string

>= 1 characters <= 120 characters

description

required

string | null

<= 1000 characters

category

required

string | null

<= 100 characters

launch_type

required

string

Allowed values: bookmark saml_sp_initiated oidc_third_party_initiated saml_idp_initiated

launch_url

required

string | null format: uri

deep_link_url

required

Optional target forwarded as target_link_uri for OIDC third-party initiated login or as RelayState for SAML IdP-initiated login. For SAML SP-initiated launch, include any application-specific destination in launch_url instead; this field must be null.

string | null format: uri

open_in_new_tab

required

boolean

icon_type

required

string

Allowed values: phosphor image

icon_value

required

string

>= 1 characters <= 2048 characters

icon_color

required

string

/^#[0-9A-Fa-f]{6}$/

background_color

required

string

/^#[0-9A-Fa-f]{6}$/

grid_width

required

integer

>= 1 <= 8

sort_order

required

integer

<= 1000000

enabled

required

boolean

allow_favorite

required

boolean

visibility

required

object

mode

required

string

Allowed values: everyone users groups attributes

attribute_match

required

string

Allowed values: all any

user_ids

required

Array<string>

<= 500 items unique items

group_ids

required

Array<string>

<= 500 items unique items

attribute_rules

required

Array<object>

<= 32 items

object

id

required

string

<= 100 characters

attribute_key

required

string

<= 128 characters

operator

required

string

Allowed values: equals not_equals contains starts_with ends_with exists

attribute_value

required

string | null

<= 500 characters

key

additional properties

key

additional properties

id

required

string

created_at

required

integer format: int64

updated_at

required

integer format: int64

Example

{
  "launcher": {
    "application_type": "standalone",
    "launch_type": "bookmark",
    "icon_type": "phosphor",
    "visibility": {
      "mode": "everyone",
      "attribute_match": "all",
      "attribute_rules": [
        {
          "operator": "equals"
        }
      ]
    }
  }
}

400

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

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

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

404

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

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