Update app

Request

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.

Required permissions: apps:edit, [appId]:edit.

Security

ClientAccessToken

Path

appIdstringrequired

ID of the application to update

Bodyapplication/jsonrequired

app_namestring

Name of the application

Example:"My App"

app_descriptionstring

Short description of the application

service_providersArray of strings

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

Default:false

authenticator_preferencesobject

Configures the application as the Authentication Hub of this tenant, allowing other apps to use it to perform a centralized login

login_uristring

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

Example:"https://www.example.com/login"

invite_member_uristring

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

Example:"https://www.example.com/login"

invite_member_email_expiration_minutesnumber

Member invite email link expiration in minutes

Default:2880

refresh_token_invalidation_trigger_configurationobject

Refresh token invalidation trigger configuration

first_client_authentication_protocolstring

Defines the first client authentication protocol.

Enum:"oidc""saml"

first_clientApiCreateOidcClientInput (object) or ApiCreateSamlClientInput (object)

One of:

Creates first client for the application. Client can be OIDC or SAML, depending what is set in first_client_authentication_protocol

logostring

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

subdomainstring

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

Example:"myapp"

custom_domainstring

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

Example:"myapp.com"

pkcestring

PKCE configuration for client

Enum:"enforcePkceInsteadOfClientCredentials""enforcePkceAlongsideClientCredentials""allowPkceAlongsideClientCredentials"

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.

Default:false

signing_key_enabledboolean

Determines if application specific signing key is enabled

Default:false

invite_client_idstring

Client used for the email magic link invitation flow

client_typestringdeprecated

Client type of the default client

Default:"web"

Enum:"web""native"

client_display_namestringdeprecated

Client name of the default client to display when needed

client_descriptionstringdeprecated

Short description of the default client

redirect_urisArray of stringsdeprecated

List of URI approved for redirects for your default client

Example:

[
  "https://www.example.com/login"
]

resourcesArray of stringsdeprecated

List of resources IDs associated with the default client

device_authorizationobjectdeprecated

Configuration for an OAuth Device Authorization Flow of the default client

ciba_authorizationobjectdeprecated

CIBA authorization flow configuration of the default client

client_auth_methodstringdeprecated

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

Default:"client_secret_basic"

Enum:"client_secret_basic""self_signed_tls_client_auth""tls_client_auth""none""private_key_jwt"

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{appId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "app_name": "My App",
    "app_description": "string",
    "service_providers": [
      "string"
    ],
    "allow_public_signup": false,
    "authenticator_preferences": {
      "is_centralized": false,
      "login_uri": "https://www.example.com/login"
    },
    "login_uri": "https://www.example.com/login",
    "invite_member_uri": "https://www.example.com/login",
    "invite_member_email_expiration_minutes": 2880,
    "refresh_token_invalidation_trigger_configuration": {
      "invalidateOnMemberSuspension": true,
      "invalidateOnMemberPasswordReset": true,
      "invalidateOnMemberRoleUpdate": true
    },
    "client_type": "web",
    "client_display_name": "string",
    "client_description": "string",
    "first_client_authentication_protocol": "oidc",
    "first_client": {
      "name": "My Client",
      "description": "string",
      "resources": [
        "string"
      ],
      "authentication_protocol": "oidc",
      "client_group_id": "string",
      "default_custom_claims": [
        "tid"
      ],
      "default_user_info_claims": [
        "tid"
      ],
      "sync_id_token_claims_to_userinfo": false,
      "short_cookies_samesite_type": "lax",
      "redirect_uris": [
        "https://www.example.com/login"
      ],
      "client_type": "web",
      "device_authorization": {
        "enabled": false,
        "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": {
        "enabled": false,
        "login_uri": "https://www.example.com/ciba/login"
      },
      "is_third_party": true,
      "allowed_scopes": [
        "string"
      ],
      "consent_uri": "string",
      "consent_validity_period": 0,
      "pkce": "enforcePkceInsteadOfClientCredentials",
      "supported_prompts": [
        "login",
        "consent",
        "none"
      ],
      "token_expiration": {
        "access_token_ttl": 0,
        "refresh_token_ttl": 0,
        "max_refresh_rotate": 0
      },
      "session_expiration": 0,
      "enforce_par": true,
      "role_ids": [
        "string"
      ],
      "fapi_version_compliancy": true,
      "token_endpoint_auth_method": "client_secret_basic",
      "response_types": [
        "code"
      ],
      "authentication_configuration": {
        "method": "client_secret_basic",
        "tls_client_auth": {
          "certificate_chain": "string",
          "distinguished_name": 6,
          "ocsp_on": true,
          "ocsp_responder_uri": "string",
          "ocsp_responder_certificate": "string",
          "ocsp_fail_open": true
        },
        "isMtlsCertTokenBound": true,
        "jwks": {}
      },
      "id_token_encryption": {
        "enabled": false,
        "jwks": {}
      }
    },
    "redirect_uris": [
      "https://www.example.com/login"
    ],
    "logo": "string",
    "resources": [
      "string"
    ],
    "device_authorization": {
      "enabled": false,
      "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": {
      "enabled": false,
      "login_uri": "https://www.example.com/ciba/login"
    },
    "client_auth_method": "client_secret_basic",
    "subdomain": "myapp",
    "custom_domain": "myapp.com",
    "pkce": "enforcePkceInsteadOfClientCredentials",
    "should_delete_signing_key": false,
    "signing_key_enabled": false,
    "invite_client_id": "string"
  }'

Responses

Bodyapplication/json

resultobjectrequired

Response

{
  "result": {
    "app_id": "string",
    "tenant_id": "string",
    "app_name": "string",
    "app_description": "string",
    "client_type": "web",
    "logo": "string",
    "client_id": "string",
    "client_display_name": "string",
    "client_description": "string",
    "client_secret": "string",
    "redirect_uris": [ … ],
    "login_preferences": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "resources": [ … ],
    "service_providers": [ … ],
    "authenticator_preferences": { … },
    "allow_public_signup": true,
    "client_auth_method": "client_secret_basic",
    "pkce": "enforcePkceInsteadOfClientCredentials",
    "device_authorization": { … },
    "ciba_authorization": { … },
    "password_sharing_group_id": "string",
    "login_uri": "https://www.example.com/login",
    "invite_member_uri": "https://www.example.com/login",
    "invite_client_id": "string",
    "subdomain": "myapp",
    "invite_member_email_expiration_minutes": 2880,
    "custom_domain": { … },
    "external_communication": { … },
    "signing_key_enabled": true,
    "refresh_token_invalidation_trigger_configuration": { … },
    "application_type": "ido"
  }
}