navigation

OAuthSettings

Namespace: Saturn
Parent: OAuth

Record type representing simple OAuth configuration to be used with use_oauth_with_settings.
Name Description
Record Fields
Schema
Signature: string

Name of the schema to be registered
CallbackPath
Signature: string

OAuth CallbackPath endpoint
AuthorizationEndpoint
Signature: string

OAuth Authorization endpoint For example: https://github.com/login/oauth/authorize
TokenEndpoint
Signature: string

OAuth Token endpoint For example: https://github.com/login/oauth/access_token
UserInformationEndpoint
Signature: string

OAuth User Information endpoint For example: https://api.github.com/user
Claims
Signature: seq

Sequance of tuples where first element is a name of the of the key in JSON object and second element is a name of the claim. For example: ["login", "githubUsername"; "name", "fullName"] where login and name are names of fields in GitHub JSON response (https://developer.github.com/v3/users/#get-the-authenticated-user).