Okta Integration Wizard: Integration Details

Fields that define how your private integration appears in Okta and the tenant variables that map per-app instance configuration values at runtime. The available fields vary based on the capabilities you selected.

Custom app properties

Table 1. Custom app properties
Field Description
Display name

Provide a name for your integration using a maximum of 64 characters. This is the main title used for your integration in the OIN.

This is a required field.

Description

Enter a general description of your app and the benefits of this integration. The app description must be less than 1024 characters. The description appears in the OIN catalog. See App description examples.

This is a required field.

Logo

Upload a PNG, JPG, or GIF file of a logo to accompany your integration in the catalog. The logo file must be less than one MB. See Logo guidelines.

This is a required field.

Tenant settings

Table 2. Tenant settings
Field Description
Label The tenant setting label that's displayed when admins install your app integration. For example: Subdomain or Tenant name
Name

Specify the tenant setting variable name using alphanumeric lowercase and underscore characters. The first character must be a letter and the maximum field length is 1024 characters. For example: subdomain_div1

String is the only variable type supported.

This variable name is used to construct dynamic URLs or other app properties that are dependent on the tenant. It's hidden from admins and is only used to pass tenant details to your external app.

Authentication settings

Table 3. Authentication settings
Field Description
Authentication mode

Select the authentication mode for API integration actions or to make outbound calls to your SCIM server.

  • Header: Uses authorization header with a customer-provided token in the following format: Authorization: {API token}

  • Bearer: Uses authorization header with a customer-provided bearer token in the following format: Authorization: Bearer {API token}
  • OAuth 2: Uses OAuth 2.0 authorization code grant flow. This is the default selection if you've selected API Integration Actions and can't be changed.

Note: Basic authentication isn't supported for SCIM. See SCIM integration limitations.

This is a required field.

OAuth 2.0 settings
Authorize endpoint

Specify the HTTPS authorize endpoint. For example: https://myexample.com/oauth2/auth

You can specify a dynamic endpoint URL. See Dynamic properties with Okta Expression Language.

This is a required field.

Token endpoint

Specify the HTTPS token endpoint. For example: https://myexample.com/oauth2/token

You can specify a dynamic endpoint URL. See Dynamic properties with Okta Expression Language.

This is a required field.

Client ID Specify the client ID.

If you're configuring this for API integration actions, specify a value to map to the Integration Builder. You can specify any string field. This field is automatically mapped to the Client ID field (auth.client_id) in the Authentication mapping section of your project in the Integration Builder.

This is a required field.

Client secret Specify the client secret.

If you're configuring this for API integration actions, specify a value to map to the Integration Builder. You can specify any string field. This field is automatically mapped to the Client Secret field (auth.client_secret) in the Authentication mapping section of your project in the Integration Builder.

This is a required field.

Scopes Optional. Specify scopes.

If you're configuring this for API integration actions, specify scopes for the resources to access.