Associated Domain Customizations

The Associated Domain Customizations API provides operations to manage associated domain customizations in your org. You can create associations between your custom domains and three well-known endpoints:

  • /.well-known/apple-app-site-association
  • /.well-known/assetlinks.json
  • /.well-known/webauthn

See Customize associated domains for more information about the endpoints and how to customize them.

Notes:

  • You can't update the well-known URI files for the default brand.
  • The maximum file size of each well-known URI file is 100 KB.

Retrieve the customized apple-app-site-association URI content

Retrieves the content of the apple-app-site-assocation well-known URI

Note: When serving this URI, Okta adds authsrv content to provide a seamless experience for Okta Verify. You can't modify the content in the authsrv object.

Responses
200

Success

429

Too Many Requests

get/.well-known/apple-app-site-association
Request samples 
Response samples 
application/json
{
  • "authsrv": {
    • "apps": [
      ],
    • "key1": "value1",
    • "key2": "value2",
    • "key3": {
      }
    }
}
Retrieve the customized assetlinks.json URI content
Retrieves the content of the assetlinks.json well-known URI


Responses 
200
Success


404
Not Found


429
Too Many Requests


get/.well-known/assetlinks.json
Request samples 
Response samples 
application/json
[
  • {
    • "key1": "value1"
    }
]
Retrieve the customized webauthn URI content
Retrieves the content of the webauthn well-known URI


Responses 
200
Success


404
Not Found


429
Too Many Requests


get/.well-known/webauthn
Request samples 
Response samples 
application/json
{}
Retrieve all the well-known URIs
Early AccessIdentity Engine
OAuth 2.0 scopes: 
  • okta.brands.read
Retrieves the content from each of the well-known URIs for a specified brand


Request 
path Parameters
brandId
required
string
The ID of the brand


 
query Parameters
expand
Array of strings
Specifies additional metadata to include in the response


Items Enum: "all" "apple-app-site-association" "assetlinks.json" "webauthn"  
Responses 
200
Successfully retrieved all the well-known URIs


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/brands/{brandId}/well-known-uris
Request samples 
Response samples 
application/json
{}
Retrieve the well-known URI of a specific brand
Early AccessIdentity Engine
OAuth 2.0 scopes: 
  • okta.brands.read
Retrieves the well-known URI of a specific brand and well-known URI path


Request 
path Parameters
brandId
required
string
The ID of the brand


 
path
required
string
The path of the well-known URI


 Enum: "apple-app-site-association" "assetlinks.json" "webauthn"  
query Parameters
expand
Array of strings
Specifies additional metadata to include in the response


Items Value: "customized"  
Responses 
200
Successfully retrieved the well-known URI


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/brands/{brandId}/well-known-uris/{path}
Request samples 
Response samples 
application/json
{}
Retrieve the customized content of the specified well-known URI
Early AccessIdentity Engine
OAuth 2.0 scopes: 
  • okta.brands.read
Retrieves the customized content of a well-known URI for a specific brand and well-known URI path


Request 
path Parameters
brandId
required
string
The ID of the brand


 
path
required
string
The path of the well-known URI


 Enum: "apple-app-site-association" "assetlinks.json" "webauthn"  
Responses 
200
Successfully retrieved the customized well-known URI content


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/brands/{brandId}/well-known-uris/{path}/customized
Request samples 
Response samples 
application/json
{}
Replace the customized well-known URI of the specific path
Early AccessIdentity Engine
OAuth 2.0 scopes: 
  • okta.brands.manage
Replaces the content of a customized well-known URI that you specify.


There are endpoint-specific format requirements when you update the content of a customized well-known URI. See Customize associated domains.


Request 
path Parameters
brandId
required
string
The ID of the brand


 
path
required
string
The path of the well-known URI


 Enum: "apple-app-site-association" "assetlinks.json" "webauthn"  
Request Body schema: application/json
representation
required
object
The well-known URI content in JSON object format


 
Responses 
200
Successfully updated the well-known URI of the specified path


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


put/api/v1/brands/{brandId}/well-known-uris/{path}/customized
Request samples 
application/json
{
  • "representation": {
    • "key1": "value1",
    • "key2": "value2",
    • "key3": {
      }
    }
}
Response samples 
application/json
{}