Index

Modules: oauth1, oauth2.

API symbols

authorizationCodeGrant:

• oauth2: proc authorizationCodeGrant(client: AsyncHttpClient; authorizeUrl, accessTokenRequestUrl, clientId, clientSecret, state: string; html: string = ""; scope: seq[string] = @[]; port: int = 8080): Future[AsyncResponse]
• oauth2: proc authorizationCodeGrant(client: HttpClient; authorizeUrl, accessTokenRequestUrl, clientId, clientSecret, state: string; html: string = ""; scope: seq[string] = @[]; port: int = 8080): Response

AuthorizationError:

• oauth2: object AuthorizationError

AuthorizationResponse:

• oauth2: type AuthorizationResponse

bearerRequest:

• oauth2: proc bearerRequest(client: AsyncHttpClient; url, accessToken: string; httpMethod = HttpGET; extraHeaders: HttpHeaders = nil; body = ""): Future[ AsyncResponse]
• oauth2: proc bearerRequest(client: HttpClient; url, accessToken: string; httpMethod = HttpGET; extraHeaders: HttpHeaders = nil; body = ""): Response

clientCredsGrant:

• oauth2: proc clientCredsGrant(client: AsyncHttpClient; url, clientid, clientsecret: string; scope: seq[string] = @[]; useBasicAuth: bool = true): Future[ AsyncResponse]
• oauth2: proc clientCredsGrant(client: HttpClient; url, clientid, clientsecret: string; scope: seq[string] = @[]; useBasicAuth: bool = true): Response

getAuthorizationCodeAccessToken:

• oauth2: proc getAuthorizationCodeAccessToken(client: AsyncHttpClient; url, code, clientId, clientSecret: string; redirectUri: string = ""; useBasicAuth: bool = true): Future[AsyncResponse]
• oauth2: proc getAuthorizationCodeAccessToken(client: HttpClient; url, code, clientId, clientSecret: string; redirectUri: string = ""; useBasicAuth: bool = true): Response

getAuthorizationCodeGrantUrl:

• oauth2: proc getAuthorizationCodeGrantUrl(url, clientId: string; redirectUri, state: string = ""; scope: openArray[string] = []; accessType: string = ""): string

getAuthorizeUrl:

• oauth1: proc getAuthorizeUrl(url, requestToken: string): string

getBasicAuthorizationHeader:

• oauth2: proc getBasicAuthorizationHeader(clientId, clientSecret: string): HttpHeaders

getBearerRequestHeader:

• oauth2: proc getBearerRequestHeader(accessToken: string): HttpHeaders

getImplicitGrantUrl:

• oauth2: proc getImplicitGrantUrl(url, clientId: string; redirectUri, state: string = ""; scope: openArray[string] = []; accessType: string = ""): string

getOAuth1AccessToken:

• oauth1: proc getOAuth1AccessToken(client: AsyncHttpClient; url, consumerKey, consumerSecret, requestToken, requestTokenSecret, verifier: string; isIncludeVersionToHeader = false; httpMethod = HttpPOST; extraHeaders: HttpHeaders = nil; body = ""; nonce: string = ""; realm: string = ""): Future[ AsyncResponse]
• oauth1: proc getOAuth1AccessToken(client: HttpClient; url, consumerKey, consumerSecret, requestToken, requestTokenSecret, verifier: string; isIncludeVersionToHeader = false; httpMethod = HttpPOST; extraHeaders: HttpHeaders = nil; body = ""; nonce: string = ""; realm: string = ""): Response

getOAuth1RequestHeader:

• oauth1: proc getOAuth1RequestHeader(params: OAuth1Parameters; extraHeaders: HttpHeaders = nil): HttpHeaders

getOAuth1RequestToken:

• oauth1: proc getOAuth1RequestToken(client: AsyncHttpClient; url, consumerKey, consumerSecret: string; callback = "oob"; isIncludeVersionToHeader = false; httpMethod = HttpPOST; extraHeaders: HttpHeaders = nil; body = ""; realm: string = ""; nonce: string = ""): Future[ AsyncResponse]
• oauth1: proc getOAuth1RequestToken(client: HttpClient; url, consumerKey, consumerSecret: string; callback = "oob"; isIncludeVersionToHeader = false; httpMethod = HttpPOST; extraHeaders: HttpHeaders = nil; body = ""; realm: string = ""; nonce: string = ""): Response

getSignature:

• oauth1: proc getSignature(HttpMethod: HttpMethod; url, body: string; params: OAuth1Parameters; consumerKey, token: string): string

implicitGrant:

• oauth2: proc implicitGrant(url, clientId, state: string; html: string = ""; scope: openArray[string] = []; port: int = 8080): string

OAuth1Parameters:

• oauth1: type OAuth1Parameters

oAuth1Request:

• oauth1: proc oAuth1Request(client: AsyncHttpClient; url, consumerKey, consumerSecret, token, tokenSecret: string; isIncludeVersionToHeader = false; httpMethod = HttpGET; extraHeaders: HttpHeaders = nil; body = ""; nonce: string = ""; realm: string = ""): Future[AsyncResponse]
• oauth1: proc oAuth1Request(client: HttpClient; url, consumerKey, consumerSecret, token, tokenSecret: string; isIncludeVersionToHeader = false; httpMethod = HttpGET; extraHeaders: HttpHeaders = nil; body = ""; nonce: string = ""; realm: string = ""): Response

parseAuthorizationResponse:

• oauth2: proc parseAuthorizationResponse(uri: string): AuthorizationResponse
• oauth2: proc parseAuthorizationResponse(uri: Uri): AuthorizationResponse

percentEncode:

• oauth1: proc percentEncode(str: string): string

RedirectUriParseError:

• oauth2: object RedirectUriParseError

refreshToken:

• oauth2: proc refreshToken(client: AsyncHttpClient; url, clientId, clientSecret, refreshToken: string; scope: seq[string] = @[]; useBasicAuth: bool = true): Future[ AsyncResponse]
• oauth2: proc refreshToken(client: HttpClient; url, clientId, clientSecret, refreshToken: string; scope: seq[string] = @[]; useBasicAuth: bool = true): Response

resourceOwnerPassCredsGrant:

• oauth2: proc resourceOwnerPassCredsGrant(client: AsyncHttpClient; url, clientId, clientSecret, username, password: string; scope: seq[string] = @[]; useBasicAuth: bool = true): Future[AsyncResponse]
• oauth2: proc resourceOwnerPassCredsGrant(client: HttpClient; url, clientId, clientSecret, username, password: string; scope: seq[string] = @[]; useBasicAuth: bool = true): Response