\AuthApi

All URIs are relative to https://api.clever-cloud.com/v2

Method	HTTP request	Description
AuthorizeForm	Get /oauth/authorize
AuthorizeToken	Post /oauth/authorize
GetAvailableRights	Get /oauth/rights
GetLoginData	Get /oauth/login_data
PostAccessTokenRequest	Post /oauth/access_token
PostAccessTokenRequestQuery	Post /oauth/access_token_query
PostAuthorize	Post /authorize
PostReqTokenRequest	Post /oauth/request_token
PostReqTokenRequestQueryString	Post /oauth/request_token_query

AuthorizeForm

string AuthorizeForm(ctx, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*AuthorizeFormOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AuthorizeFormOpts struct

Name	Type	Description	Notes
ccid	optional.String
cctk	optional.String
oauthToken	optional.String
ccid2	optional.String
cliToken	optional.String
fromOauth	optional.String

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AuthorizeToken

AuthorizeToken(ctx, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*AuthorizeTokenOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AuthorizeTokenOpts struct

Name	Type	Description	Notes
ccid	optional.String
cctk	optional.String
almighty	optional.String
accessOrganisations	optional.String
manageOrganisations	optional.String
manageOrganisationsServices	optional.String
manageOrganisationsApplications	optional.String
manageOrganisationsMembers	optional.String
accessOrganisationsBills	optional.String
accessOrganisationsCreditCount	optional.String
accessOrganisationsConsumptionStatistics	optional.String
accessPersonalInformation	optional.String
managePersonalInformation	optional.String
manageSshKeys	optional.String

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: text/html, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAvailableRights

GetAvailableRights(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLoginData

GetLoginData(ctx, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetLoginDataOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetLoginDataOpts struct

Name	Type	Description	Notes
oauthKey	optional.String

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostAccessTokenRequest

PostAccessTokenRequest(ctx, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*PostAccessTokenRequestOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PostAccessTokenRequestOpts struct

Name	Type	Description	Notes
oauthConsumerKey	optional.String
oauthToken	optional.String
oauthSignatureMethod	optional.String
oauthSignature	optional.String
oauthTimestamp	optional.String
oauthNonce	optional.String
oauthVersion	optional.String
oauthVerifier	optional.String
oauthCallback	optional.String
oauthTokenSecret	optional.String
oauthCallbackConfirmed	optional.String

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/x-www-form-urlencoded

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostAccessTokenRequestQuery

PostAccessTokenRequestQuery(ctx, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*PostAccessTokenRequestQueryOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PostAccessTokenRequestQueryOpts struct

Name	Type	Description	Notes
oauthConsumerKey	optional.String
oauthToken	optional.String
oauthSignatureMethod	optional.String
oauthSignature	optional.String
oauthTimestamp	optional.String
oauthNonce	optional.String
oauthVersion	optional.String
oauthVerifier	optional.String
oauthCallback	optional.String
oauthTokenSecret	optional.String
oauthCallbackConfirmed	optional.String

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/x-www-form-urlencoded

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostAuthorize

Message PostAuthorize(ctx, wannabeAuthorization)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
wannabeAuthorization	WannabeAuthorization

Return type

Message

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostReqTokenRequest

string PostReqTokenRequest(ctx, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*PostReqTokenRequestOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PostReqTokenRequestOpts struct

Name	Type	Description	Notes
cleverFlavor	optional.String
oauthConsumerKey	optional.String
oauthToken	optional.String
oauthSignatureMethod	optional.String
oauthSignature	optional.String
oauthTimestamp	optional.String
oauthNonce	optional.String
oauthVersion	optional.String
oauthVerifier	optional.String
oauthCallback	optional.String
oauthTokenSecret	optional.String
oauthCallbackConfirmed	optional.String

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/x-www-form-urlencoded

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostReqTokenRequestQueryString

string PostReqTokenRequestQueryString(ctx, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*PostReqTokenRequestQueryStringOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PostReqTokenRequestQueryStringOpts struct

Name	Type	Description	Notes
cleverFlavor	optional.String
oauthConsumerKey	optional.String
oauthToken	optional.String
oauthSignatureMethod	optional.String
oauthSignature	optional.String
oauthTimestamp	optional.String
oauthNonce	optional.String
oauthVersion	optional.String
oauthVerifier	optional.String
oauthCallback	optional.String
oauthTokenSecret	optional.String
oauthCallbackConfirmed	optional.String

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/x-www-form-urlencoded

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

AuthApi.md

Latest commit

History

AuthApi.md

File metadata and controls

\AuthApi

AuthorizeForm

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

AuthorizeToken

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

GetAvailableRights

Required Parameters

Return type

Authorization

HTTP request headers

GetLoginData

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

PostAccessTokenRequest

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

PostAccessTokenRequestQuery

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

PostAuthorize

Required Parameters

Return type

Authorization

HTTP request headers

PostReqTokenRequest

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

PostReqTokenRequestQueryString

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers