providers_rac_partial_update

PATCH 
/api/v3//providers/rac/:id/

RACProvider Viewset

Request

Path Parameters

id integerrequired

A unique integer value identifying this RAC Provider.

application/json

Body

name string

Possible values: non-empty

authentication_flow uuidnullable

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

authorization_flow uuid

Flow used when authorizing this provider.

property_mappings uuid[]
settings
connection_expiry string

Possible values: non-empty

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.

Responses

200

application/json

Schema

Schema

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.

Example (from schema)

{
  "pk": 0,
  "name": "string",
  "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "authorization_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",
  "settings": {},
  "outpost_set": [
    "string"
  ],
  "connection_expiry": "string",
  "delete_token_on_disconnect": true
}

400

application/json

Schema

Schema

non_field_errors string[]
code string

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PATCH '/api/v3/providers/rac/:id/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "authorization_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "settings": {},
  "connection_expiry": "string",
  "delete_token_on_disconnect": true
}'

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

id — pathrequired

Body

{
  "name": "string",
  "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "authorization_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "settings": {},
  "connection_expiry": "string",
  "delete_token_on_disconnect": true
}