rac_connection_tokens_partial_update

PATCH 
/api/v3//rac/connection_tokens/:connection_token_uuid/

ConnectionToken Viewset

Request

Path Parameters

connection_token_uuid uuidrequired

A UUID string identifying this RAC Connection token.

application/json

Body

pk uuid
provider integer
endpoint uuid

Responses

200

application/json

Schema

Schema

pk uuid
provider integerrequired

provider_obj

object

required

RACProvider 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.

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

settings

outpost_set string[]required

connection_expiry string

Determines how long a session lasts. Default of 0 means that the sessions lasts until the browser is closed. (Format: hours=-1;minutes=-2;seconds=-3)

delete_token_on_disconnect boolean

When set to true, connection tokens will be deleted upon disconnect.

endpoint uuidrequired

endpoint_obj

object

required

Endpoint Serializer

pk uuidrequired

name stringrequired

provider integerrequired

provider_obj

object

required

RACProvider 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.

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

settings

outpost_set string[]required

connection_expiry string

Determines how long a session lasts. Default of 0 means that the sessions lasts until the browser is closed. (Format: hours=-1;minutes=-2;seconds=-3)

delete_token_on_disconnect boolean

When set to true, connection tokens will be deleted upon disconnect.

protocol ProtocolEnum (string)required

Possible values: [rdp, vnc, ssh]

host stringrequired

settings

property_mappings uuid[]

auth_mode AuthModeEnum (string)required

Possible values: [static, prompt]

launch_url stringnullablerequired

Build actual launch URL (the provider itself does not have one, just individual endpoints)

maximum_connections integer

Possible values: >= -2147483648 and <= 2147483647

user

object

required

Stripped down user serializer to show relevant users for groups

pk ID (integer)required

username stringrequired

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Possible values: <= 150 characters, Value must match regular expression ^[\w.@+-]+$

name stringrequired

User's display name.

is_active Active (boolean)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

last_login date-timenullable

email email

Possible values: <= 254 characters

attributes object

uid stringrequired

Example (from schema)

{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "provider": 0,
  "endpoint": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

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

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "/api/v3/rac/connection_tokens/:connection_token_uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var content = new StringContent("{\n  \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"provider\": 0,\n  \"endpoint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\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

Parameters

connection_token_uuid — pathrequired

Body

{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "provider": 0,
  "endpoint": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}