of the application the user is logging into
Optional scope: ApiRole[]roles being requested - space delimited string or array
Optional customRoles: string[]optional custom roles being requested - string array
Optional anonuserid?: stringProvide an externally generated id to track this user session, used specifically for the tracking events feature for integrating with Send and Discover
Optional cancelProvide an axios cancelToken that can be used to cancel the request.
Optional requestProvide a value that can be used to identify the type of request. Useful for error logs.
this workflow is best suited for a backend system
of the application
of the application the user is logging into
Optional scope: ApiRole[]roles being requested - space delimited string or array
Optional customRoles: string[]optional custom roles being requested - string array
Optional cancelProvide an axios cancelToken that can be used to cancel the request.
Optional requestProvide a value that can be used to identify the type of request. Useful for error logs.
similar to login except client secret is also required, adding another level of security
of the application
of the user logging in
of the user logging in
of the application the user is logging into
Optional scope: ApiRole[]roles being requested - space delimited string or array
Optional customRoles: string[]optional custom roles being requested - string array
Optional cancelProvide an axios cancelToken that can be used to cancel the request.
Optional requestProvide a value that can be used to identify the type of request. Useful for error logs.
this workflow is most appropriate for client apps where user is a human, ie a registered user
of the user logging in
of the user logging in
Optional scope: ApiRole[]optional roles being requested, if omitted will return all assigned roles
Optional customRoles: string[]optional custom roles being requested - string array
Optional cancelProvide an axios cancelToken that can be used to cancel the request.
Optional requestProvide a value that can be used to identify the type of request. Useful for error logs.
extend your users' session by getting a new access token with a refresh token. refresh tokens must be enabled in the dashboard
of the application
of the application the user is logging into
Optional cancelProvide an axios cancelToken that can be used to cancel the request.
Optional requestProvide a value that can be used to identify the type of request. Useful for error logs.
Generated using TypeDoc
Description
allow users to browse your catalog without signing in - must have anonymous template user set in dashboard