Skip to main content
PATCH
Update provider connection

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Provider connection sid (in_cn_...).

Required string length: 18
Pattern: ^in_cn_

Body

application/json

Request body of update_provider_connection.

name
string

New name, 1..255 chars.

Required string length: 1 - 255
status
enum<string>

on | off; failed is never client-settable.

Available options:
on,
off
auth_type
enum<string> | null

With auth: the new secret's shape (the pair rotates together).

Available options:
api_key,
bearer,
basic,
header,
query
auth
object

WRITE-ONLY, never echoed: {key} for api_key or bearer, {username, password} for basic, {header_name, value} for header, {param_name, value} for query.

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.