A complete list of fields supported in Appspace Custom Passport configuration, including general fields, OAuth fields, and profile mapping fields. Use this reference when creating or importing a Custom Passport to ensure all required values are provided.
General Fields
General fields apply to all Custom Passports regardless of authentication type.
| Field | Required | Description |
|---|---|---|
name | Yes | Unique identifier for the passport. Must contain only letters, numbers, and hyphens. |
displayName | No | User-friendly display name shown in the Appspace interface. |
description | No | Brief description of the integration shown on the passport list. |
categoryType | No | Category for grouping passports. Supported values: Custom, Publishing, Delegations, Calendar, Library, Social, Dashboard, Conferencing, People, Places. Defaults to Custom. |
authenticationType | Yes | Authentication mechanism used by the passport. Supported value: OAuth. |
OAuth Fields
OAuth fields are required when authenticationType is set to OAuth. These values must be obtained from the third-party OAuth application registration.
| Field | Required | Description |
|---|---|---|
clientId | Yes | OAuth Client ID issued by the third-party provider. |
clientSecret | Yes | OAuth Client Secret issued by the third-party provider. Cleared from exported JSON files. |
authenticationUrl | Yes | OAuth authorization endpoint where users grant access. |
tokenUrl | Yes | OAuth token exchange endpoint used to retrieve access tokens. |
scope | No | Space-separated list of OAuth scopes to request from the provider. |
Profile Mapping Fields
Profile mapping fields tell Appspace how to extract user identity values from the third-party provider's profile response. All path fields use JSONPath expressions.
| Field | Required | Description |
|---|---|---|
profileUrl | No | Endpoint that returns the connected user's profile data after authentication. |
profileAccountEmailPath | No | JSONPath expression to extract the user email from the profile response. Example: $.email. |
profileAccountIdPath | No | JSONPath expression to extract the user ID from the profile response. Example: $.id. |
profileAccountNamePath | No | JSONPath expression to extract the user display name from the profile response. Example: $.name. |
Related Articles