Skip to main content

rac_connection_tokens_update

PUT 
/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.

Bodyrequired

    pkuuid
    providerintegerrequired
    endpointuuidrequired

Responses​

Schema
    pkuuid
    providerintegerrequired
    provider_obj object

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

    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

    settings
    outpost_setstring[]required
    connection_expirystring

    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_disconnectboolean

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

    endpointuuidrequired
    endpoint_obj object

    Endpoint Serializer

    pkuuidrequired
    namestringrequired
    providerintegerrequired
    provider_obj objectrequired

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

    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

    settings
    outpost_setstring[]required
    connection_expirystring

    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_disconnectboolean

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

    protocolProtocolEnum (string)required

    Possible values: [rdp, vnc, ssh]

    hoststringrequired
    settings
    property_mappingsuuid[]
    auth_modeAuthModeEnum (string)required

    Possible values: [static, prompt]

    launch_urlstringnullablerequired

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

    maximum_connectionsinteger

    Possible values: >= -2147483648 and <= 2147483647

    user object

    Stripped down user serializer to show relevant users for groups

    pkID (integer)required
    usernamestringrequired

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

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

    namestringrequired

    User's display name.

    is_activeActive (boolean)

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

    last_logindate-timenullable
    emailemail

    Possible values: <= 254 characters

    attributes object
    property name*any
    uidstringrequired

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "/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
Parameters
— pathrequired
Body required
{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "provider": 0,
  "endpoint": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}