ReferenceHTTP APIWorkspace settings

Set the author App's client secret for user linking (owner or admin)

PUT
/v1/workspaces/{id}/github-settings/oauth-client-secret

Stores the client secret of the author GitHub App people link their accounts with (oauth.connection_id), made in GitHub under the App's settings, so people can link their GitHub account. It is kept encrypted like the App's private key and never returned, logged or echoed; the answer carries only whether one is set. Setting it again replaces it. Registering a different App, or deleting the author App, drops it. Refused with 409 GITHUB_LINK_NOT_CONFIGURED (reason_code no_author_app) while the workspace has no author App. client_id names the App the secret was made for, as oauth.client_id showed it; when the author App's client id is another one by the time the secret is stored (the App was replaced meanwhile), nothing is stored and the answer is 409 REVISION_CONFLICT (reason_code github_app_changed). Writes a set_github_app receipt with the secret's last four characters. Does not change the ceiling's revision. API keys are refused.

Auth: cookie session only; no scope. Idempotency-Key: ignored.

Authorization

cookieSession
cookie__Host-werft_session<token>

For the web console: the browser session cookie set by POST /v1/auth/login. It holds the scopes of the user's workspace role (owner: all; admin and member: all but sessions:recover). Requests other than GET must also send X-Requested-With: werft-web.

Path Parameters

id*string

The workspace's id.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Header Parameters

X-Requested-With?"werft-web"

Required with a cookie session: the literal werft-web.

Value in"werft-web"

Request Body

application/json
  1. body
client_id*string
Length1 <= length <= 255
client_secret*string
Match^[\x21-\x7e]+$
Length8 <= length <= 4096

Response Body

Stored; the receipt and the user-linking state.

application/json
  1. response
receipt_id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
oauth*
Example Request
curl -X PUT 'https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/github-settings/oauth-client-secret' \  -H 'Content-Type: application/json' \  -d '{  "client_id": "Iv23liExampleClientId",  "client_secret": "<client-secret-from-github>"}'
Example Response
{  "receipt_id": "c4a1e9d2-7b3f-4e8a-a6c5-1d2e3f4a5b6c",  "oauth": {    "client_id": "Iv23liExampleClientId",    "client_secret_set": true,    "callback_url": "https://console.example.com/settings/linked-accounts/github"  }}