v1

latestOpenAPI 3.0.32026-08-061946146.3 KB

Update app

Updates an application. The fields marked as deprecated are now managed on the client level. To update a default client, create additional clients, or fetch all app clients, use /clients or applications/{appId}/clients endpoints. Note: Fields that are objects cannot be partially updated, since the new value you set will just replace the current one. <br><br>Required permissions: apps:edit, [appId]:edit.

put/v1/applications/{appId}

Path parameters

appIdstring required

ID of the application to update

Request body

app_namestring

Name of the application

app_descriptionstring

Short description of the application

service_providersstring[]

List of service provider IDs associated with this application

allow_public_signupboolean

Determines if the application is allowed to request to create new users via login flows

login_uristring

URI used to redirect the user to the login page of the application (when needed)

invite_member_uristring

URI used to redirect the member to the login page of the application (when needed)

invite_member_email_expiration_minutesnumber

Member invite email link expiration in minutes

client_type'web' | 'native'

Client type of the default client

client_display_namestring

Client name of the default client to display when needed

client_descriptionstring

Short description of the default client

first_client_authentication_protocol'oidc' | 'saml'

Defines the first client authentication protocol.

redirect_urisstring[]

List of URI approved for redirects for your default client

logostring

URI of your application's logo, such as for email templates

resourcesstring[]

List of resources IDs associated with the default client

client_auth_method'client_secret_basic' | 'self_signed_tls_client_auth' | 'tls_client_auth' | 'none' | 'private_key_jwt'

This field is deprecated- to configure pkce use "pkce" field instead

subdomainstring

Subdomain of Org admin portal that can be offered for organizations to manage their users (when needed)

custom_domainstring

Domain of the application that can be offered for the application to be accessed from

pkce'enforcePkceInsteadOfClientCredentials' | 'enforcePkceAlongsideClientCredentials' | 'allowPkceAlongsideClientCredentials'

PKCE configuration for client

should_delete_signing_keyboolean

Determines whether the application-specific signing key should be deleted when disabled. If deleted, any tokens previously issued with this key will no longer be valid.

signing_key_enabledboolean

Determines if application specific signing key is enabled

invite_client_idstring

Client used for the email magic link invitation flow

Example request

{
  "app_name": "My App",
  "authenticator_preferences": {
    "login_uri": "https://www.example.com/login"
  },
  "login_uri": "https://www.example.com/login",
  "invite_member_uri": "https://www.example.com/login",
  "first_client": {
    "name": "My Client",
    "redirect_uris": [
      "https://www.example.com/login"
    ],
    "device_authorization": {
      "approval_uri": "https://www.example.com/device/approval",
      "success_uri": "https://www.example.com/device/complete",
      "input_uri": "https://www.example.com/device/start"
    },
    "ciba_authorization": {
      "login_uri": "https://www.example.com/ciba/login"
    },
    "supported_prompts": [
      "login",
      "consent",
      "none"
    ],
    "response_types": [
      "code"
    ],
    "authentication_configuration": {
      "tls_client_auth": {
        "distinguished_name": 6
      }
    }
  },
  "redirect_uris": [
    "https://www.example.com/login"
  ],
  "device_authorization": {
    "approval_uri": "https://www.example.com/device/approval",
    "success_uri": "https://www.example.com/device/complete",
    "input_uri": "https://www.example.com/device/start"
  },
  "ciba_authorization": {
    "login_uri": "https://www.example.com/ciba/login"
  },
  "subdomain": "myapp",
  "custom_domain": "myapp.com"
}

Response

Example response

{
  "result": {
    "login_preferences": {
      "auth_methods": {
        "google": {
          "redirectUris": [
            "https://www.example.com/login"
          ]
        },
        "facebook": {
          "redirectUris": [
            "https://www.example.com/login"
          ]
        },
        "email_otp": {
          "lockoutDuration": 15,
          "maxFailures": 3,
          "codeLength": 6
        },
        "apple": {
          "redirectUris": [
            "https://www.example.com/login"
          ]
        },
        "sms": {
          "lockoutDuration": 15,
          "maxFailures": 3,
          "codeLength": 6
        },
        "webauthn_api": {
          "failuresExpireIn": 15,
          "lockoutTiers": [
            {
              "attempts": 3,
              "duration": 15
            }
          ],
          "maxFailures": 3,
          "lockoutDuration": 15
        },
        "line": {
          "redirectUris": [
            "https://www.example.com/login"
          ]
        },
        "password": {
          "failuresExpireIn": 15,
          "lockoutTiers": [
            {
              "attempts": 3,
              "duration": 15
            }
          ],
          "resetValidityMinutes": 5,
          "passwordComplexity": 5,
          "passwordMinLength": 14,
          "passwordExpiresIn": 90,
          "maxPasswordFailures": 5,
          "passwordSuspensionDuration": 15,
          "tempPasswordValidityHours": 24,
          "codeLength": 6
        },
        "totp": {
          "failuresExpireIn": 15,
          "lockoutTiers": [
            {
              "attempts": 3,
              "duration": 15
            }
          ],
          "digits": 6,
          "period": 30,
          "window": 2,
          "issuer": "My Company",
          "maxFailures": 3,
          "lockoutDuration": 15,
          "maxTotpPerUser": 1
        },
        "tiktok": {
          "redirectUris": [
            "https://www.example.com/login"
          ]
        },
        "pin_authenticator": {
          "failuresExpireIn": 15,
          "lockoutTiers": [
            {
              "attempts": 3,
              "duration": 15
            }
          ],
          "maxFailures": 3,
          "lockoutDuration": 15
        },
        "face": {
          "failuresExpireIn": 15,
          "lockoutTiers": [
            {
              "attempts": 3,
              "duration": 15
            }
          ],
          "maxFailures": 3,
          "lockoutDuration": 15
        }
      }
    },
    "authenticator_preferences": {
      "login_uri": "https://www.example.com/login"
    },
    "device_authorization": {
      "approval_uri": "https://www.example.com/device/approval",
      "success_uri": "https://www.example.com/device/complete",
      "input_uri": "https://www.example.com/device/start"
    },
    "ciba_authorization": {
      "login_uri": "https://www.example.com/ciba/login"
    },
    "login_uri": "https://www.example.com/login",
    "invite_member_uri": "https://www.example.com/login",
    "subdomain": "myapp",
    "custom_domain": {
      "domain": "myapp.com"
    }
  }
}