wolfadex / elm-open-api / OpenApi.OauthFlow

Corresponds to the OAuth Flows Object in the OpenAPI specification, as well as the OAuth Flow Object.

Types


type OauthFlows


type ImplicitFlow


type PasswordFlow


type ClientCredentialsFlow


type AuthorizationCodeFlow

Decoding / Encoding

decodeFlows : Json.Decode.Decoder OauthFlows

encodeFlows : OauthFlows -> Json.Encode.Value

decodeImplicit : Json.Decode.Decoder ImplicitFlow

encodeImplicit : ImplicitFlow -> Json.Encode.Value

decodePassword : Json.Decode.Decoder PasswordFlow

encodePassword : PasswordFlow -> Json.Encode.Value

decodeClientCredentials : Json.Decode.Decoder ClientCredentialsFlow

encodeClientCredentials : ClientCredentialsFlow -> Json.Encode.Value

decodeAuthorizationCode : Json.Decode.Decoder AuthorizationCodeFlow

encodeAuthorizationCode : AuthorizationCodeFlow -> Json.Encode.Value

Querying

OAuth Flows

implicit : OauthFlows -> Maybe ImplicitFlow

password : OauthFlows -> Maybe PasswordFlow

clientCredentials : OauthFlows -> Maybe ClientCredentialsFlow

authorizationCode : OauthFlows -> Maybe AuthorizationCodeFlow

Implicit Flows

implicitAuthorizationUrl : ImplicitFlow -> String

implicitRefreshUrl : ImplicitFlow -> Maybe String

implicitScopes : ImplicitFlow -> Dict String String

Password Flows

passwordTokenUrl : PasswordFlow -> String

passwordRefreshUrl : PasswordFlow -> Maybe String

passwordScopes : PasswordFlow -> Dict String String

Client Credential Flows

clientCredentialTokenUrl : ClientCredentialsFlow -> String

clientCredentialRefreshUrl : ClientCredentialsFlow -> Maybe String

clientCredentialScopes : ClientCredentialsFlow -> Dict String String

Authorization Code Flows

authorizationCodeAuthorizationUrl : AuthorizationCodeFlow -> String

authorizationCodeTokenUrl : AuthorizationCodeFlow -> String

authorizationCodeRefreshUrl : AuthorizationCodeFlow -> Maybe String

authorizationCodeScopes : AuthorizationCodeFlow -> Dict String String