1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
|
package linodego
import (
"context"
)
// OAuthClientStatus constants start with OAuthClient and include Linode API Instance Status values
type OAuthClientStatus string
// OAuthClientStatus constants reflect the current status of an OAuth Client
const (
OAuthClientActive OAuthClientStatus = "active"
OAuthClientDisabled OAuthClientStatus = "disabled"
OAuthClientSuspended OAuthClientStatus = "suspended"
)
// OAuthClient represents a OAuthClient object
type OAuthClient struct {
// The unique ID of this OAuth Client.
ID string `json:"id"`
// The location a successful log in from https://login.linode.com should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange.
RedirectURI string `json:"redirect_uri"`
// The name of this application. This will be presented to users when they are asked to grant it access to their Account.
Label string `json:"label"`
// Current status of the OAuth Client, Enum: "active" "disabled" "suspended"
Status OAuthClientStatus `json:"status"`
// The OAuth Client secret, used in the OAuth exchange. This is returned as <REDACTED> except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.
Secret string `json:"secret"`
// If this OAuth Client is public or private.
Public bool `json:"public"`
// The URL where this client's thumbnail may be viewed, or nil if this client does not have a thumbnail set.
ThumbnailURL *string `json:"thumbnail_url"`
}
// OAuthClientCreateOptions fields are those accepted by CreateOAuthClient
type OAuthClientCreateOptions struct {
// The location a successful log in from https://login.linode.com should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange.
RedirectURI string `json:"redirect_uri"`
// The name of this application. This will be presented to users when they are asked to grant it access to their Account.
Label string `json:"label"`
// If this OAuth Client is public or private.
Public bool `json:"public"`
}
// OAuthClientUpdateOptions fields are those accepted by UpdateOAuthClient
type OAuthClientUpdateOptions struct {
// The location a successful log in from https://login.linode.com should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange.
RedirectURI string `json:"redirect_uri"`
// The name of this application. This will be presented to users when they are asked to grant it access to their Account.
Label string `json:"label"`
// If this OAuth Client is public or private.
Public bool `json:"public"`
}
// GetCreateOptions converts a OAuthClient to OAuthClientCreateOptions for use in CreateOAuthClient
func (i OAuthClient) GetCreateOptions() (o OAuthClientCreateOptions) {
o.RedirectURI = i.RedirectURI
o.Label = i.Label
o.Public = i.Public
return
}
// GetUpdateOptions converts a OAuthClient to OAuthClientUpdateOptions for use in UpdateOAuthClient
func (i OAuthClient) GetUpdateOptions() (o OAuthClientUpdateOptions) {
o.RedirectURI = i.RedirectURI
o.Label = i.Label
o.Public = i.Public
return
}
// ListOAuthClients lists OAuthClients
func (c *Client) ListOAuthClients(ctx context.Context, opts *ListOptions) ([]OAuthClient, error) {
response, err := getPaginatedResults[OAuthClient](ctx, c, "account/oauth-clients", opts)
if err != nil {
return nil, err
}
return response, nil
}
// GetOAuthClient gets the OAuthClient with the provided ID
func (c *Client) GetOAuthClient(ctx context.Context, clientID string) (*OAuthClient, error) {
e := formatAPIPath("account/oauth-clients/%s", clientID)
response, err := doGETRequest[OAuthClient](ctx, c, e)
if err != nil {
return nil, err
}
return response, nil
}
// CreateOAuthClient creates an OAuthClient
func (c *Client) CreateOAuthClient(ctx context.Context, opts OAuthClientCreateOptions) (*OAuthClient, error) {
e := "account/oauth-clients"
response, err := doPOSTRequest[OAuthClient](ctx, c, e, opts)
if err != nil {
return nil, err
}
return response, nil
}
// UpdateOAuthClient updates the OAuthClient with the specified id
func (c *Client) UpdateOAuthClient(ctx context.Context, clientID string, opts OAuthClientUpdateOptions) (*OAuthClient, error) {
e := formatAPIPath("account/oauth-clients/%s", clientID)
response, err := doPUTRequest[OAuthClient](ctx, c, e, opts)
if err != nil {
return nil, err
}
return response, nil
}
// DeleteOAuthClient deletes the OAuthClient with the specified id
func (c *Client) DeleteOAuthClient(ctx context.Context, clientID string) error {
e := formatAPIPath("account/oauth-clients/%s", clientID)
err := doDELETERequest(ctx, c, e)
return err
}
// ResetOAuthClientSecret resets the OAuth Client secret for a client with a specified id
func (c *Client) ResetOAuthClientSecret(ctx context.Context, clientID string) (*OAuthClient, error) {
e := formatAPIPath("account/oauth-clients/%s/reset-secret", clientID)
response, err := doPOSTRequest[OAuthClient, any](ctx, c, e)
if err != nil {
return nil, err
}
return response, nil
}
|