IPWorks Auth 2020 JavaScript Edition

Questions / Feedback?

State Property

Opaque value used to maintain state between the request and response.

Syntax


 getState(): string;

 setState(state: string): void;

Default Value

""

Remarks

This property optionally holds a string value which will be returned by the authorization server with the response.

Any value may be specified here and it will be returned exactly as it was sent. This can be used to maintain state within the application, and also may be used for security purposes (for instance to prevent Cross-Site Request Forgery). The contents of this property are treated as an opaque value.

When ClientProfile is set to cfApplication the ReturnURL event provides the state value returned by the authorization server.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks Auth 2020 JavaScript Edition - Version 20.0 [Build 7721]