core_applications_create

POST 
/api/v3//core/applications/

Application Viewset

Request

application/json

Bodyrequired

namestringrequired
Application's display Name.
Possible values: non-empty
slugstringrequired
Internal application name, used in URLs.
Possible values: non-empty and <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$
providerintegernullable
backchannel_providersinteger[]
open_in_new_tabboolean
Open launch URL in a new browser tab or window.
meta_launch_urluri
meta_descriptionstring
meta_publisherstring
policy_engine_modePolicyEngineMode (string)
Possible values: [all, any]
groupstring

Responses

201

application/json

Schema

Schema

pkuuidrequired
namestringrequired
Application's display Name.
slugstringrequired
Internal application name, used in URLs.
Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$
providerintegernullable
provider_obj object
Provider Serializer
pkID (integer)required
namestringrequired
authentication_flowuuidnullable
Flow used for authentication when the associated application is accessed by an un-authenticated user.
authorization_flowuuidrequired
Flow used when authorizing this provider.
invalidation_flowuuidrequired
Flow used ending the session from a provider.
property_mappingsuuid[]
componentstringrequired
Get object component so that we know how to edit the object
assigned_application_slugstringrequired
Internal application name, used in URLs.
assigned_application_namestringrequired
Application's display Name.
assigned_backchannel_application_slugstringrequired
Internal application name, used in URLs.
assigned_backchannel_application_namestringrequired
Application's display Name.
verbose_namestringrequired
Return object's verbose_name
verbose_name_pluralstringrequired
Return object's plural verbose_name
meta_model_namestringrequired
Return internal model name
backchannel_providersinteger[]
backchannel_providers_obj object[]required
Array [
pkID (integer)required
namestringrequired
authentication_flowuuidnullable
Flow used for authentication when the associated application is accessed by an un-authenticated user.
authorization_flowuuidrequired
Flow used when authorizing this provider.
invalidation_flowuuidrequired
Flow used ending the session from a provider.
property_mappingsuuid[]
componentstringrequired
Get object component so that we know how to edit the object
assigned_application_slugstringrequired
Internal application name, used in URLs.
assigned_application_namestringrequired
Application's display Name.
assigned_backchannel_application_slugstringrequired
Internal application name, used in URLs.
assigned_backchannel_application_namestringrequired
Application's display Name.
verbose_namestringrequired
Return object's verbose_name
verbose_name_pluralstringrequired
Return object's plural verbose_name
meta_model_namestringrequired
Return internal model name
]
launch_urlstringnullablerequired
Allow formatting of launch URL
open_in_new_tabboolean
Open launch URL in a new browser tab or window.
meta_launch_urluri
meta_iconstringnullablerequired
Get the URL to the App Icon image. If the name is /static or starts with http it is returned as-is
meta_descriptionstring
meta_publisherstring
policy_engine_modePolicyEngineMode (string)
Possible values: [all, any]
groupstring

Example (auto)

{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "slug": "string",
  "provider": 0,
  "provider_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"
  },
  "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_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

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

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

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

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "/api/v3/core/applications/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"slug\": \"string\",\n  \"provider\": 0,\n  \"backchannel_providers\": [\n    0\n  ],\n  \"open_in_new_tab\": true,\n  \"meta_launch_url\": \"string\",\n  \"meta_description\": \"string\",\n  \"meta_publisher\": \"string\",\n  \"policy_engine_mode\": \"all\",\n  \"group\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Body required

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