io.swagger.client.model

Class ClientConfigurationParams

java.lang.Object

io.swagger.client.model.ClientConfigurationParams

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2018-05-14T19:12:52.919Z")
public class ClientConfigurationParams
extends Object

Client configuration parameters

Constructor Summary

Constructors

Constructor and Description
ClientConfigurationParams()

Method Summary

Modifier and Type	Method and Description
ClientConfigurationParams	clientAccessTokensValidityPeriod(Integer clientAccessTokensValidityPeriod)
boolean	equals(Object o)
Integer	getClientAccessTokensValidityPeriod() The validity period that newly requested access tokens for clients initially have (in seconds).
Integer	getRefreshTokensValidityPeriod() The validity period that newly requested refresh tokens initially have (in seconds).
Integer	getUserAccessTokensValidityPeriod() The validity period that newly requested access tokens for users initially have (in seconds).
String	getUserNotificationCallbackUrl() Callback URL to which finAPI sends the notification messages that are triggered from the automatic batch update of the users' bank connections.
String	getUserSynchronizationCallbackUrl() Callback URL for user synchronization.
int	hashCode()
ClientConfigurationParams	refreshTokensValidityPeriod(Integer refreshTokensValidityPeriod)
void	setClientAccessTokensValidityPeriod(Integer clientAccessTokensValidityPeriod)
void	setRefreshTokensValidityPeriod(Integer refreshTokensValidityPeriod)
void	setUserAccessTokensValidityPeriod(Integer userAccessTokensValidityPeriod)
void	setUserNotificationCallbackUrl(String userNotificationCallbackUrl)
void	setUserSynchronizationCallbackUrl(String userSynchronizationCallbackUrl)
String	toString()
ClientConfigurationParams	userAccessTokensValidityPeriod(Integer userAccessTokensValidityPeriod)
ClientConfigurationParams	userNotificationCallbackUrl(String userNotificationCallbackUrl)
ClientConfigurationParams	userSynchronizationCallbackUrl(String userSynchronizationCallbackUrl)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientConfigurationParams

public ClientConfigurationParams()

Method Detail

userNotificationCallbackUrl

public ClientConfigurationParams userNotificationCallbackUrl(String userNotificationCallbackUrl)

getUserNotificationCallbackUrl

public String getUserNotificationCallbackUrl()

Callback URL to which finAPI sends the notification messages that are triggered from the automatic batch update of the users' bank connections. This field is only relevant if the automatic batch update is enabled for your client. For details about what the notification messages look like, please see the documentation in the 'Notification Rules' section. finAPI will call this URL with HTTP method POST. Note that the response of the call is not processed by finAPI. Also note that while the callback URL may be a non-secured (http) URL on the finAPI sandbox or alpha environment, it MUST be a SSL-secured (https) URL on the finAPI live system.<p>The maximum allowed length of the URL is 512. If you have previously set a callback URL and now want to clear it (thus disabling user-related notifications altogether), you can pass an empty string (\"\").

Returns:

userNotificationCallbackUrl

setUserNotificationCallbackUrl

public void setUserNotificationCallbackUrl(String userNotificationCallbackUrl)

userSynchronizationCallbackUrl

public ClientConfigurationParams userSynchronizationCallbackUrl(String userSynchronizationCallbackUrl)

getUserSynchronizationCallbackUrl

public String getUserSynchronizationCallbackUrl()

Callback URL for user synchronization. This field should be set if you - as a finAPI customer - have multiple clients using finAPI. In such case, all of your clients will share the same user base, making it possible for a user to be created in one client, but then deleted in another. To keep the client-side user data consistent in all clients, you should set a callback URL for each client. finAPI will send a notification to the callback URL of each client whenever a user of your user base gets deleted. Note that finAPI will send a deletion notification to ALL clients, including the one that made the user deletion request to finAPI. So when deleting a user in finAPI, a client should rely on the callback to delete the user on its own side. <p>The notification that finAPI sends to the clients' callback URLs will be a POST request, with this body: <pre>{ \"userId\" : string // contains the identifier of the deleted user \"event\" : string // this will always be \"DELETED\" }</pre><br/>Note that finAPI does not process the response of this call. Also note that while the callback URL may be a non-secured (http) URL on the finAPI sandbox or alpha system, it MUST be a SSL-secured (https) URL on the live system.</p>As long as you have just one client, you can ignore this field and let it be null. However keep in mind that in this case your client will not receive any callback when a user gets deleted - so the deletion of the user on the client-side must not be forgotten. Of course you may still use the callback URL even for just one client, if you want to implement the deletion of the user on the client-side via the callback from finAPI.<p> The maximum allowed length of the URL is 512. If you have previously set a callback URL and now want to clear it (thus disabling user synchronization related notifications for this client), you can pass an empty string (\"\").

Returns:

userSynchronizationCallbackUrl

setUserSynchronizationCallbackUrl

public void setUserSynchronizationCallbackUrl(String userSynchronizationCallbackUrl)

refreshTokensValidityPeriod

public ClientConfigurationParams refreshTokensValidityPeriod(Integer refreshTokensValidityPeriod)

getRefreshTokensValidityPeriod

public Integer getRefreshTokensValidityPeriod()

The validity period that newly requested refresh tokens initially have (in seconds). The value must be greater than or equal to 60, or 0. A value of 0 means that the tokens never expire (Unless explicitly invalidated, e.g. by revocation , or when a user gets locked, or when the password is reset for a user).

Returns:

refreshTokensValidityPeriod

setRefreshTokensValidityPeriod

public void setRefreshTokensValidityPeriod(Integer refreshTokensValidityPeriod)

userAccessTokensValidityPeriod

public ClientConfigurationParams userAccessTokensValidityPeriod(Integer userAccessTokensValidityPeriod)

getUserAccessTokensValidityPeriod

public Integer getUserAccessTokensValidityPeriod()

The validity period that newly requested access tokens for users initially have (in seconds). The value must be greater than or equal to 60, or 0. A value of 0 means that the tokens never expire.

Returns:

userAccessTokensValidityPeriod

setUserAccessTokensValidityPeriod

public void setUserAccessTokensValidityPeriod(Integer userAccessTokensValidityPeriod)

clientAccessTokensValidityPeriod

public ClientConfigurationParams clientAccessTokensValidityPeriod(Integer clientAccessTokensValidityPeriod)

getClientAccessTokensValidityPeriod

public Integer getClientAccessTokensValidityPeriod()

The validity period that newly requested access tokens for clients initially have (in seconds). The value must be greater than or equal to 60, or 0. A value of 0 means that the tokens never expire.

Returns:

clientAccessTokensValidityPeriod

setClientAccessTokensValidityPeriod

public void setClientAccessTokensValidityPeriod(Integer clientAccessTokensValidityPeriod)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object