core_applications_partial_update

PATCH 
/api/v3//core/applications/:slug/

Application Viewset

Request

Path Parameters

slug stringrequired

application/json

Body

name string

Application's display Name.

Possible values: non-empty

slug string

Internal application name, used in URLs.

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

provider integernullable
backchannel_providers integer[]
open_in_new_tab boolean

Open launch URL in a new browser tab or window.

meta_launch_url uri
meta_description string
meta_publisher string
policy_engine_mode PolicyEngineMode (string)

Possible values: [all, any]

group string

Responses

200

application/json

Schema

Schema

pk uuidrequired
name stringrequired

Application's display Name.

slug stringrequired

Internal application name, used in URLs.

Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

provider integernullable

provider_obj

object

required

Provider Serializer

pk ID (integer)required

name stringrequired

authentication_flow uuidnullable

Flow used for authentication when the associated application is accessed by an un-authenticated user.

authorization_flow uuidrequired

Flow used when authorizing this provider.

invalidation_flow uuidrequired

Flow used ending the session from a provider.

property_mappings uuid[]

component stringrequired

Get object component so that we know how to edit the object

assigned_application_slug stringrequired

Internal application name, used in URLs.

assigned_application_name stringrequired

Application's display Name.

assigned_backchannel_application_slug stringrequired

Internal application name, used in URLs.

assigned_backchannel_application_name stringrequired

Application's display Name.

verbose_name stringrequired

Return object's verbose_name

verbose_name_plural stringrequired

Return object's plural verbose_name

meta_model_name stringrequired

Return internal model name

backchannel_providers integer[]

backchannel_providers_obj

object[]

required

Array [

pk ID (integer)required

name stringrequired

authentication_flow uuidnullable

Flow used for authentication when the associated application is accessed by an un-authenticated user.

authorization_flow uuidrequired

Flow used when authorizing this provider.

invalidation_flow uuidrequired

Flow used ending the session from a provider.

property_mappings uuid[]

component stringrequired

Get object component so that we know how to edit the object

assigned_application_slug stringrequired

Internal application name, used in URLs.

assigned_application_name stringrequired

Application's display Name.

assigned_backchannel_application_slug stringrequired

Internal application name, used in URLs.

assigned_backchannel_application_name stringrequired

Application's display Name.

verbose_name stringrequired

Return object's verbose_name

verbose_name_plural stringrequired

Return object's plural verbose_name

meta_model_name stringrequired

Return internal model name

]

launch_url stringnullablerequired

Allow formatting of launch URL

open_in_new_tab boolean

Open launch URL in a new browser tab or window.

meta_launch_url uri
meta_icon stringnullablerequired

Get the URL to the App Icon image. If the name is /static or starts with http it is returned as-is

meta_description string
meta_publisher string
policy_engine_mode PolicyEngineMode (string)

Possible values: [all, any]

group string

Example (from schema)

{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "slug": "string",
  "provider": 0,
  "backchannel_providers": [
    0
  ],
  "backchannel_providers_obj": [
    {
      "pk": 0,
      "name": "string",
      "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "authorization_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "invalidation_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "property_mappings": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "component": "string",
      "assigned_application_slug": "string",
      "assigned_application_name": "string",
      "assigned_backchannel_application_slug": "string",
      "assigned_backchannel_application_name": "string",
      "verbose_name": "string",
      "verbose_name_plural": "string",
      "meta_model_name": "string"
    }
  ],
  "launch_url": "string",
  "open_in_new_tab": true,
  "meta_launch_url": "string",
  "meta_icon": "string",
  "meta_description": "string",
  "meta_publisher": "string",
  "policy_engine_mode": "all",
  "group": "string"
}

400

application/json

Schema

Schema

non_field_errors string[]
code string
property name* any

Validation Error

Example (from schema)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "detail": "string",
  "code": "string"
}

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

slug — pathrequired

Body

{
  "name": "string",
  "slug": "string",
  "provider": 0,
  "backchannel_providers": [
    0
  ],
  "open_in_new_tab": true,
  "meta_launch_url": "string",
  "meta_description": "string",
  "meta_publisher": "string",
  "policy_engine_mode": "all",
  "group": "string"
}