Update client

POST /2023-03-01/management/client

Update attributes of the client. Update the name, client_secret, or webhook_uri of the client

application/json

Body Required

  • client_secret array[string] Required

    The client secret(s). It is an array datatype to allow for rotation of secrets without downtime for your customers

  • redirect_uris array[string] Required

    Indicates the URI to return the user to after authorization is complete, which is the endpoint on your server to receive the authorization_code.

    Must be identical to the redirect URI provided in the original link.

    Please email me after signup and I will set both your client secret and redirect_uri (required) when you reach out.

  • name string Required

    Name of your app that shows up in the Affix Connect application

  • webhook_uri string | null

    If enabled, webhooks will be sent to this endpoint

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • client_id string Required

      The client ID you received when you first created the application

    • client_secret array[string] Required

      The client secret(s). It is an array datatype to allow for rotation of secrets without downtime for your customers

    • redirect_uris array[string] Required

      Indicates the URI to return the user to after authorization is complete, which is the endpoint on your server to receive the authorization_code.

      Must be identical to the redirect URI provided in the original link.

      Please email me after signup and I will set both your client secret and redirect_uri (required) when you reach out.

    • name string Required

      Name of your app that shows up in the Affix Connect application

    • webhook_uri string | null

      If enabled, webhooks will be sent to this endpoint

  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
  • 401 application/json

    Authentication Error

    Hide response attributes Show response attributes object
    • error string Required

      The type of error

      Value is authentication_error.

    • message string Required

      A descriptive description of the error

    • code string Required

      Values are incorrect_username_or_password, incorrect_mfa_or_otp, reauthentication_required // cookies are now expired, additional_account_setup_required // password reset, etc, captcha_challenge // amazon type1 captcha challenge (currently unsovable), no_valid_accounts // not used currently but reserved for future use, or insufficient_permission // not enough privileges (ie not an admin, or not enough provider scopes on a provider api token for the Affix scopes requested).

  • 409 application/json

    Not Found

    Hide response attributes Show response attributes object
    • code string

      The authorization code insert that caused a conflict

    • token string

      The access token insert that caused a conflict

    • error string Required

      The description of the type of error, ie conflict of two requests of the the same authorization code

      Value is conflict.

  • 429 application/json

    Rate Limited / Too Many Requests

    Hide headers attribute Show headers attribute
    • Retry your call after the specified amount of seconds

    Hide response attribute Show response attribute object
  • 500 application/json

    Server Error

    Hide response attribute Show response attribute object
POST /2023-03-01/management/client
curl \
 -X POST https://api.affixapi.com/2023-03-01/management/client \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"client_secret":["ffffffff-ffffffff-ffffffff-ffffffff","aaaaaaaa-aaaaaaaa-aaaaaaaa-aaaaaaaa"],"redirect_uris":["https://app.your-company.com","https://dev.app.your-company.com"],"name":"Your App","webhook_uri":"https://webhooks.your-company.com/aaaaaaaa-aaaaaaaa-aaaaaaaa-aaaaaaaa"}'
Request example
{
  "client_secret": [
    "ffffffff-ffffffff-ffffffff-ffffffff",
    "aaaaaaaa-aaaaaaaa-aaaaaaaa-aaaaaaaa"
  ],
  "redirect_uris": [
    "https://app.your-company.com",
    "https://dev.app.your-company.com"
  ],
  "name": "Your App",
  "webhook_uri": "https://webhooks.your-company.com/aaaaaaaa-aaaaaaaa-aaaaaaaa-aaaaaaaa"
}
Response examples (200)
{
  "client_id": "00000000-00000000-00000000-00000000",
  "client_secret": [
    "ffffffff-ffffffff-ffffffff-ffffffff",
    "aaaaaaaa-aaaaaaaa-aaaaaaaa-aaaaaaaa"
  ],
  "redirect_uris": [
    "https://app.your-company.com",
    "https://dev.app.your-company.com"
  ],
  "name": "Your App",
  "webhook_uri": "https://webhooks.your-company.com/aaaaaaaa-aaaaaaaa-aaaaaaaa-aaaaaaaa"
}
Response examples (400)
{
  "message": "string",
  "validation_error": "string"
}
Response examples (401)
{
  "error": "authentication_error",
  "message": "Your password is incorrect",
  "code": "incorrect_username_or_password"
}
Response examples (409)
{
  "code": "string",
  "token": "string",
  "error": "conflict"
}
Response examples (429)
# Headers
Retry-After: 42

# Payload
{
  "message": "string"
}
Response examples (500)
{
  "message": "string"
}