Skip to content

Latest commit

 

History

History
1353 lines (770 loc) · 33.7 KB

UserApi.md

File metadata and controls

1353 lines (770 loc) · 33.7 KB
Raw

\UserApi

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

Method HTTP request Description
AskForPasswordResetViaForm Post /password_forgotten
AuthorizePaypalTransaction Put /invoice/external/paypal/{bid}
CancelPaypalTransaction Delete /invoice/external/paypal/{bid}
ConfirmPasswordResetRequest Get /password_forgotten/{key}
CreateUserFromForm Post /users
DeleteGithubLink Delete /github/link
FinsihGithubSignup Post /github/signup
GetApplications Get /users/{id}/applications
GetEnv Get /application/{appId}/environment
GetGitInfo Get /users/{userId}/git-info
GetGithub Get /github
GetGithubApplications Get /github/applications
GetGithubCallback Get /github/callback
GetGithubEmails Get /github/emails
GetGithubKeys Get /github/keys
GetGithubLink Get /github/link
GetGithubLogin Get /github/login
GetGithubUsername Get /github/username
GetLoginForm Get /session/login
GetLoginForm1 Get /sessions/login
GetPasswordForgottenForm Get /password_forgotten
GetSignupForm Get /session/signup
GetSignupForm1 Get /sessions/signup
GetUserById Get /users/{id}
GithubSignup Get /github/signup
Login Post /session/login
Login1 Post /sessions/login
MfaLogin Post /session/mfa_login
MfaLogin1 Post /sessions/mfa_login
PostGithubRedeploy Post /github/redeploy
ResetPasswordForgotten Post /password_forgotten/{key}
UpdateEnv Put /application/{appId}/environment
UpdateInvoice Post /invoice/external/{bid}

AskForPasswordResetViaForm

string AskForPasswordResetViaForm(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a AskForPasswordResetViaFormOpts struct

Name Type Description Notes
login optional.String
dropTokens optional.String
cleverFlavor optional.String

Return type

string

Authorization

No authorization required

HTTP request headers

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

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

AuthorizePaypalTransaction

AuthorizePaypalTransaction(ctx, bid, paymentData)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bid string
paymentData PaymentData

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]

CancelPaypalTransaction

CancelPaypalTransaction(ctx, bid)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bid 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]

ConfirmPasswordResetRequest

string ConfirmPasswordResetRequest(ctx, key, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ConfirmPasswordResetRequestOpts struct

Name Type Description Notes

cleverFlavor | optional.String| |

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

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

CreateUserFromForm

CreateUserFromForm(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a CreateUserFromFormOpts struct

Name Type Description Notes
invitationKey optional.String
addonBetaInvitationKey optional.String
email optional.String
pass optional.String
urlNext optional.String
terms optional.String
subscriptionSource optional.String
cleverFlavor optional.String
oauthToken optional.String

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

DeleteGithubLink

Message DeleteGithubLink(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

Message

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]

FinsihGithubSignup

string FinsihGithubSignup(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a FinsihGithubSignupOpts struct

Name Type Description Notes
transactionId optional.String
name optional.String
otherId optional.String
otherEmail optional.String
password optional.String
autoLink optional.String
terms optional.String
invitationKey optional.String
mfaKind optional.String
mfaAttempt optional.String

Return type

string

Authorization

No authorization required

HTTP request headers

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

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

GetApplications

[]ApplicationView GetApplications(ctx, id)

Required Parameters

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

Return type

[]ApplicationView

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]

GetEnv

string GetEnv(ctx, appId, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetEnvOpts struct

Name Type Description Notes

token | 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]

GetGitInfo

string GetGitInfo(ctx, userId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId 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]

GetGithub

OAuthTransactionView GetGithub(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

OAuthTransactionView

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]

GetGithubApplications

[]OAuthApplicationView GetGithubApplications(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]OAuthApplicationView

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]

GetGithubCallback

GetGithubCallback(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetGithubCallbackOpts struct

Name Type Description Notes
ccOAuthData optional.String
code optional.String
state optional.String
error_ optional.String
errorDescription optional.String
errorUri 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]

GetGithubEmails

[]string GetGithubEmails(ctx, )

Required Parameters

This endpoint does not need any parameter.

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]

GetGithubKeys

[]SshKeyView GetGithubKeys(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]SshKeyView

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]

GetGithubLink

string GetGithubLink(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetGithubLinkOpts struct

Name Type Description Notes
transactionId optional.String
redirectUrl 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]

GetGithubLogin

GetGithubLogin(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetGithubLoginOpts struct

Name Type Description Notes
redirectUrl optional.String
fromAuthorize optional.String
cliToken optional.String
cleverFlavor optional.String
oauthToken optional.String
invitationKey optional.String
subscriptionSource 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]

GetGithubUsername

string GetGithubUsername(ctx, )

Required Parameters

This endpoint does not need any parameter.

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]

GetLoginForm

string GetLoginForm(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetLoginFormOpts struct

Name Type Description Notes
secondaryEmailKey optional.String
deletionKey optional.String
fromAuthorize optional.String
cliToken optional.String
cleverFlavor optional.String

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

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

GetLoginForm1

string GetLoginForm1(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetLoginForm1Opts struct

Name Type Description Notes
secondaryEmailKey optional.String
deletionKey optional.String
fromAuthorize optional.String
cliToken optional.String
cleverFlavor optional.String

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

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

GetPasswordForgottenForm

string GetPasswordForgottenForm(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetPasswordForgottenFormOpts struct

Name Type Description Notes
cleverFlavor optional.String

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

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

GetSignupForm

string GetSignupForm(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetSignupFormOpts struct

Name Type Description Notes
invitationKey optional.String
urlNext optional.String
cleverFlavor optional.String

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

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

GetSignupForm1

string GetSignupForm1(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetSignupForm1Opts struct

Name Type Description Notes
invitationKey optional.String
urlNext optional.String
cleverFlavor optional.String

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

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

GetUserById

UserView GetUserById(ctx, id)

Required Parameters

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

Return type

UserView

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]

GithubSignup

GithubSignup(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GithubSignupOpts struct

Name Type Description Notes
redirectUrl optional.String
fromAuthorize optional.String
cliToken optional.String
cleverFlavor optional.String
oauthToken optional.String
invitationKey optional.String
subscriptionSource optional.String
terms 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]

Login

string Login(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a LoginOpts struct

Name Type Description Notes
email optional.String
pass optional.String
fromAuthorize optional.String
cliToken optional.String
cleverFlavor optional.String
oauthToken optional.String

Return type

string

Authorization

No authorization required

HTTP request headers

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

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

Login1

string Login1(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a Login1Opts struct

Name Type Description Notes
email optional.String
pass optional.String
fromAuthorize optional.String
cliToken optional.String
cleverFlavor optional.String
oauthToken optional.String

Return type

string

Authorization

No authorization required

HTTP request headers

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

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

MfaLogin

[]OAuthApplicationView MfaLogin(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a MfaLoginOpts struct

Name Type Description Notes
mfaKind optional.String
mfaAttempt optional.String
email optional.String
authId optional.String
fromAuthorize optional.String
cliToken optional.String
cleverFlavor optional.String
oauthToken optional.String

Return type

[]OAuthApplicationView

Authorization

No authorization required

HTTP request headers

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

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

MfaLogin1

[]OAuthApplicationView MfaLogin1(ctx, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a MfaLogin1Opts struct

Name Type Description Notes
mfaKind optional.String
mfaAttempt optional.String
email optional.String
authId optional.String
fromAuthorize optional.String
cliToken optional.String
cleverFlavor optional.String
oauthToken optional.String

Return type

[]OAuthApplicationView

Authorization

No authorization required

HTTP request headers

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

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

PostGithubRedeploy

Message PostGithubRedeploy(ctx, githubWebhookPayload, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a PostGithubRedeployOpts struct

Name Type Description Notes

userAgent | optional.String| | xGithubEvent | optional.String| | xHubSignature | optional.String| |

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]

ResetPasswordForgotten

string ResetPasswordForgotten(ctx, key, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ResetPasswordForgottenOpts struct

Name Type Description Notes

pass | optional.String| | pass2 | optional.String| |

Return type

string

Authorization

No authorization required

HTTP request headers

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

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

UpdateEnv

Message UpdateEnv(ctx, appId, body, optional)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a UpdateEnvOpts struct

Name Type Description Notes

token | optional.String| |

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]

UpdateInvoice

UpdateInvoice(ctx, bid, endOfInvoiceResponse)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bid string
endOfInvoiceResponse EndOfInvoiceResponse

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]