Connected applications
| Administration Page | Application/Contract | Syracuse/Collaboration | |
|---|---|---|---|
| Class | connectedApplications | Representation | connectedApplication |
This function is used to declare connected applications. They will be used from a SAFE X3 dedicated API.
A connected application is identified by a client ID that is generated when saving a new instance. This client ID is mandatory, unique and will be used when the call is done.
Parameters
The other parameters that have to be entered are the following:
Name
Defines a friendly name that can be remembered by a human. This name is only for information and helps administrators to identify the connected application.
Url
Defines the url of the connected application such as http(s)://server:port.
Client ID
Defines the UUID of the connected application. It is a read only property which will be initialized with a uuid without dash characters when saving a new instance.
Secret
This property corresponds to a private/shared secret used to sign/verify the JWT token. It is a read only property stored securely like a password.
The secret is displayed only when creating an instance but will no longer be displayed.
The secret is generated using a random string password generator.
If the administrator does not remember the secret, he can regenerate a new one with the Regenerate secret action.
Active
Defines if the connected application is currently active.
Token validity
Defines the validity span of a generated token.
Expressed in seconds
Operation
An operation called Regenerate secret is available on the right panel. This service can be used when the administrator does not remember the previously generated secret.
The new generated secret will be displayed only after calling the operation, but will no longer be displayed.
Warning: When this action is called, all currently valid tokens corresponding to the connected application are revoked.
See also
The ASYRCONNAPP library contains the functions used to generate JWT tokens or formatted Urls corresponding to a connected application.