Creating Portal Apps
Creating a Portal OAuth app
You will need to create a Portal App.
- Log into the Portal Tools using your Portal account
- Click the Create New App button.
- In "Name", type the name of your app.
- In "Logo URL", type the URL for the logo (optional).
- In the "Configure your app screen" enter the redirect URLs (ie https://app.example.com/auth/callback).
- Choose the applicable grant types.
- Choose App authentication mode.
- Public - For apps authenticating via PCKE (ie Javascript apps).
- Private - For server to server auth flows.
| PARAMETER NAME | TYPE | DESCRIPTION |
|---|---|---|
name | string | The name of the 0Auth app |
callbacks | string[] | An array of strings. The strings provided must be valid URLs |
grantTypes | string[] |
|
clientType | string | Private clients require that both client and client id are provided to exchange an access token. When the responseType is set to private the token_endpoint_auth_method is set client_secret_post - Provide client credentials in the client post body. When the response type is set to "public" the token_endpoint_auth_method none - Register the client as a public client which cannot use client secret. (required for PKCE, device token flows) |
authMethod | string | String indicator of the requested authentication method for the token endpoint. Values defined by this specification are: https://datatracker.ietf.org/doc/html/rfc7591#section-2 ` * "none": The client is a public client as defined in OAuth 2.0,Section 2.1, and does not have a client secret.
|
Native Apps
Native APIs are used for platforms such as Unity or Unreal. Native apps require a specific format for redirectUris to be used.
When the clientType is set to native the format of the url should be defined using reverse domain format org.example.photoprintr://auth/callback as described here https://www.oauth.com/oauth2-servers/oauth-native-apps/redirect-urls-for-native-apps>