Create a partner app

Register an OAuth application. Returns the client secret once.

POST /v1/apps

Create a partner OAuth application

cURL

curl --request POST \
  --url https://api.swapnice.com/v1/apps \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-swapnice-admin-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "redirect_uris": [
    "<string>"
  ],
  "allowed_scopes": [
    "<string>"
  ],
  "scopes": [
    "<string>"
  ],
  "allowed_consent_purposes": [],
  "webhook_default_url": "<string>"
}
'

201

{
  "app_id": "<string>",
  "client_id": "<string>",
  "client_secret": "<string>",
  "name": "<string>",
  "redirect_uris": [
    "<string>"
  ],
  "scopes": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z"
}

Register an OAuth application. Returns the client secret once.

Usually called by Swapnice during onboarding with an app registration key. Store client_secret immediately.

Authorizations

x-swapnice-admin-key · string · header · required

Administrative registration key for creating partner applications.

Headers

Idempotency-Key · string · required

Required for mutating requests. Replays with the same key and payload hash return the original logical result; replays with a different payload hash return 409.

Required string length: 16 - 255

X-Request-Id · string

Optional caller-supplied correlation ID echoed in responses and errors.

Body

application/json

name · string · required

redirect_uris · string<uri>[] · required

Minimum array length: 1

client_type · enum<string>

Available options: public, confidential

allowed_scopes · string[]

Minimum array length: 1

scopes · string[]

Backwards-compatible alias for allowed_scopes.

Minimum array length: 1

allowed_consent_purposes · enum<string>[]

Available options: account_linking, personalization, analytics, support, event_enrichment, profile_resolution, measurement

webhook_default_url · string<uri>

Response

201

application/json

Application created.

app_id · string · required

client_id · string · required

client_secret · string · required

One-time client secret.

name · string · required

redirect_uris · string<uri>[] · required

scopes · string[] · required

created_at · string<date-time> · required