Management is our GraphQL API, which gives providers access to interact with the platform to perform operations that are not naturally documented in OAuth specification. This documentation describes keys related to important objects in our Management GraphQL API.
Application
An Application indicates one product which a provider intends to use the Connect solution in. When creating a new application with the Management API, the description of the following parameters might come in handy.
|
authentication_strategies required |
list(string) | A list of authentication strategy codes to be enabled as authentication strategies |
|
default_locale required |
string | Locale to use by default if there is no override |
|
description required |
string | A description of the application |
|
locales required |
string | Zero or Many locales which are highlighted by default |
|
logo_url optional |
string | URL to the logo of the application |
|
code required |
string | Code of the application. Choose it wisely as it is immutable |
|
name required |
string | Name of the application |
|
public_key optional |
string | A Public SSH Key formatted as PEM to encrypt JWT tokens |
|
redirect_uris required |
string | A list of redirect uris |
|
default_home_page required |
string | A default URL for this Application. Users can be redirected here when they get lost. |
|
required_identities required |
list(string) | List of the identities (i.e. phone, email) required to succesfully complete an authentication |
|
scopes optional |
list(string) | List of scopes that an application wants access to and that will require User’s approval |
|
signup_application_id optional |
string | Signup Application ID that new Users will be redirected to if they are not already present in the database (first time login) |
|
type optional |
string | Type of the application between public or confidential (default: public) |
Authentication Strategies
Authentication Strategies indicates the type of authentication that will be supported by a provider through the integrated Application. When creating an authentication strategy, the following parameters will be required after registering and retrieving relevant credentials from the 3rd party provider.
|
add_as_scope optional |
boolean | If true, a scope will be created with the same name as this authentication strategy only if token_exchange is enabled for the strategy. |
|
code required |
string | A code representing the authentication strategy e.g. apple, google |
|
client_id required |
string | Social Application Client ID: This is the client_id retrieved after registering on the social platform e.g. google |
|
client_secret required |
UUID | Social Application Client Secret: This is the client_secret retrieved after registering on the social platform |
|
scopes optional |
string | Social Application scopes e.g. 'openid profile': The scope to be specified when making the authorization request to social provider. |
Identity
When creating a new user identity or updating one, the description of the following parameters will be helpful.
|
locale_code required |
string | An existing locale code |
|
status required |
string | The current status of the identity e.g. unvalidated | validated |
|
type required |
string | An existing type for the identity |
|
user_id required |
UUID | A valid Connect user Identity |
|
value required |
string | A value relevant to the type |