aws-sdk-go: github.com/aws/aws-sdk-go/service/ssooidc Index | Files | Directories

package ssooidc

import "github.com/aws/aws-sdk-go/service/ssooidc"

Package ssooidc provides the client and types for making API requests to AWS SSO OIDC.

AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI or a native application) to register with AWS SSO. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of the device authorization grant standard (https://tools.ietf.org/html/rfc8628 (https://tools.ietf.org/html/rfc8628)).

For general information about AWS SSO, see What is AWS Single Sign-On? (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) in the AWS SSO User Guide.

This API reference guide describes the AWS SSO OIDC operations that you can call programatically and includes detailed information on data types and errors.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a convenient way to create programmatic access to AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services (http://aws.amazon.com/tools/).

See https://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10 for more information on this service.

See ssooidc package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/ssooidc/

Using the Client

To contact AWS SSO OIDC with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS SSO OIDC client SSOOIDC for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/ssooidc/#New

Index

Package Files

api.go doc.go errors.go service.go

Constants

const (

    // ErrCodeAccessDeniedException for service response error code
    // "AccessDeniedException".
    //
    // You do not have sufficient access to perform this action.
    ErrCodeAccessDeniedException = "AccessDeniedException"

    // ErrCodeAuthorizationPendingException for service response error code
    // "AuthorizationPendingException".
    //
    // Indicates that a request to authorize a client with an access user session
    // token is pending.
    ErrCodeAuthorizationPendingException = "AuthorizationPendingException"

    // ErrCodeExpiredTokenException for service response error code
    // "ExpiredTokenException".
    //
    // Indicates that the token issued by the service is expired and is no longer
    // valid.
    ErrCodeExpiredTokenException = "ExpiredTokenException"

    // ErrCodeInternalServerException for service response error code
    // "InternalServerException".
    //
    // Indicates that an error from the service occurred while trying to process
    // a request.
    ErrCodeInternalServerException = "InternalServerException"

    // ErrCodeInvalidClientException for service response error code
    // "InvalidClientException".
    //
    // Indicates that the clientId or clientSecret in the request is invalid. For
    // example, this can occur when a client sends an incorrect clientId or an expired
    // clientSecret.
    ErrCodeInvalidClientException = "InvalidClientException"

    // ErrCodeInvalidClientMetadataException for service response error code
    // "InvalidClientMetadataException".
    //
    // Indicates that the client information sent in the request during registration
    // is invalid.
    ErrCodeInvalidClientMetadataException = "InvalidClientMetadataException"

    // ErrCodeInvalidGrantException for service response error code
    // "InvalidGrantException".
    //
    // Indicates that a request contains an invalid grant. This can occur if a client
    // makes a CreateToken request with an invalid grant type.
    ErrCodeInvalidGrantException = "InvalidGrantException"

    // ErrCodeInvalidRequestException for service response error code
    // "InvalidRequestException".
    //
    // Indicates that something is wrong with the input to the request. For example,
    // a required parameter might be missing or out of range.
    ErrCodeInvalidRequestException = "InvalidRequestException"

    // ErrCodeInvalidScopeException for service response error code
    // "InvalidScopeException".
    //
    // Indicates that the scope provided in the request is invalid.
    ErrCodeInvalidScopeException = "InvalidScopeException"

    // ErrCodeSlowDownException for service response error code
    // "SlowDownException".
    //
    // Indicates that the client is making the request too frequently and is more
    // than the service can handle.
    ErrCodeSlowDownException = "SlowDownException"

    // ErrCodeUnauthorizedClientException for service response error code
    // "UnauthorizedClientException".
    //
    // Indicates that the client is not currently authorized to make the request.
    // This can happen when a clientId is not issued for a public client.
    ErrCodeUnauthorizedClientException = "UnauthorizedClientException"

    // ErrCodeUnsupportedGrantTypeException for service response error code
    // "UnsupportedGrantTypeException".
    //
    // Indicates that the grant type in the request is not supported by the service.
    ErrCodeUnsupportedGrantTypeException = "UnsupportedGrantTypeException"
)
const (
    ServiceName = "SSO OIDC" // Name of service.
    EndpointsID = "oidc"     // ID to lookup a service endpoint with.
    ServiceID   = "SSO OIDC" // ServiceID is a unique identifer of a specific service.
)

Service information constants

type CreateTokenInput Uses

type CreateTokenInput struct {

    // The unique identifier string for each client. This value should come from
    // the persisted result of the RegisterClient API.
    //
    // ClientId is a required field
    ClientId *string `locationName:"clientId" type:"string" required:"true"`

    // A secret string generated for the client. This value should come from the
    // persisted result of the RegisterClient API.
    //
    // ClientSecret is a required field
    ClientSecret *string `locationName:"clientSecret" type:"string" required:"true"`

    // The authorization code received from the authorization service. This parameter
    // is required to perform an authorization grant request to get access to a
    // token.
    Code *string `locationName:"code" type:"string"`

    // Used only when calling this API for the device code grant type. This short-term
    // code is used to identify this authentication attempt. This should come from
    // an in-memory reference to the result of the StartDeviceAuthorization API.
    //
    // DeviceCode is a required field
    DeviceCode *string `locationName:"deviceCode" type:"string" required:"true"`

    // Supports grant types for authorization code, refresh token, and device code
    // request.
    //
    // GrantType is a required field
    GrantType *string `locationName:"grantType" type:"string" required:"true"`

    // The location of the application that will receive the authorization code.
    // Users authorize the service to send the request to this location.
    RedirectUri *string `locationName:"redirectUri" type:"string"`

    // The token used to obtain an access token in the event that the access token
    // is invalid or expired. This token is not issued by the service.
    RefreshToken *string `locationName:"refreshToken" type:"string"`

    // The list of scopes that is defined by the client. Upon authorization, this
    // list is used to restrict permissions when granting an access token.
    Scope []*string `locationName:"scope" type:"list"`
    // contains filtered or unexported fields
}

func (CreateTokenInput) GoString Uses

func (s CreateTokenInput) GoString() string

GoString returns the string representation

func (*CreateTokenInput) SetClientId Uses

func (s *CreateTokenInput) SetClientId(v string) *CreateTokenInput

SetClientId sets the ClientId field's value.

func (*CreateTokenInput) SetClientSecret Uses

func (s *CreateTokenInput) SetClientSecret(v string) *CreateTokenInput

SetClientSecret sets the ClientSecret field's value.

func (*CreateTokenInput) SetCode Uses

func (s *CreateTokenInput) SetCode(v string) *CreateTokenInput

SetCode sets the Code field's value.

func (*CreateTokenInput) SetDeviceCode Uses

func (s *CreateTokenInput) SetDeviceCode(v string) *CreateTokenInput

SetDeviceCode sets the DeviceCode field's value.

func (*CreateTokenInput) SetGrantType Uses

func (s *CreateTokenInput) SetGrantType(v string) *CreateTokenInput

SetGrantType sets the GrantType field's value.

func (*CreateTokenInput) SetRedirectUri Uses

func (s *CreateTokenInput) SetRedirectUri(v string) *CreateTokenInput

SetRedirectUri sets the RedirectUri field's value.

func (*CreateTokenInput) SetRefreshToken Uses

func (s *CreateTokenInput) SetRefreshToken(v string) *CreateTokenInput

SetRefreshToken sets the RefreshToken field's value.

func (*CreateTokenInput) SetScope Uses

func (s *CreateTokenInput) SetScope(v []*string) *CreateTokenInput

SetScope sets the Scope field's value.

func (CreateTokenInput) String Uses

func (s CreateTokenInput) String() string

String returns the string representation

func (*CreateTokenInput) Validate Uses

func (s *CreateTokenInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateTokenOutput Uses

type CreateTokenOutput struct {

    // An opaque token to access AWS SSO resources assigned to a user.
    AccessToken *string `locationName:"accessToken" type:"string"`

    // Indicates the time in seconds when an access token will expire.
    ExpiresIn *int64 `locationName:"expiresIn" type:"integer"`

    // The identifier of the user that associated with the access token, if present.
    IdToken *string `locationName:"idToken" type:"string"`

    // A token that, if present, can be used to refresh a previously issued access
    // token that might have expired.
    RefreshToken *string `locationName:"refreshToken" type:"string"`

    // Used to notify the client that the returned token is an access token. The
    // supported type is BearerToken.
    TokenType *string `locationName:"tokenType" type:"string"`
    // contains filtered or unexported fields
}

func (CreateTokenOutput) GoString Uses

func (s CreateTokenOutput) GoString() string

GoString returns the string representation

func (*CreateTokenOutput) SetAccessToken Uses

func (s *CreateTokenOutput) SetAccessToken(v string) *CreateTokenOutput

SetAccessToken sets the AccessToken field's value.

func (*CreateTokenOutput) SetExpiresIn Uses

func (s *CreateTokenOutput) SetExpiresIn(v int64) *CreateTokenOutput

SetExpiresIn sets the ExpiresIn field's value.

func (*CreateTokenOutput) SetIdToken Uses

func (s *CreateTokenOutput) SetIdToken(v string) *CreateTokenOutput

SetIdToken sets the IdToken field's value.

func (*CreateTokenOutput) SetRefreshToken Uses

func (s *CreateTokenOutput) SetRefreshToken(v string) *CreateTokenOutput

SetRefreshToken sets the RefreshToken field's value.

func (*CreateTokenOutput) SetTokenType Uses

func (s *CreateTokenOutput) SetTokenType(v string) *CreateTokenOutput

SetTokenType sets the TokenType field's value.

func (CreateTokenOutput) String Uses

func (s CreateTokenOutput) String() string

String returns the string representation

type RegisterClientInput Uses

type RegisterClientInput struct {

    // The friendly name of the client.
    //
    // ClientName is a required field
    ClientName *string `locationName:"clientName" type:"string" required:"true"`

    // The type of client. The service supports only public as a client type. Anything
    // other than public will be rejected by the service.
    //
    // ClientType is a required field
    ClientType *string `locationName:"clientType" type:"string" required:"true"`

    // The list of scopes that are defined by the client. Upon authorization, this
    // list is used to restrict permissions when granting an access token.
    Scopes []*string `locationName:"scopes" type:"list"`
    // contains filtered or unexported fields
}

func (RegisterClientInput) GoString Uses

func (s RegisterClientInput) GoString() string

GoString returns the string representation

func (*RegisterClientInput) SetClientName Uses

func (s *RegisterClientInput) SetClientName(v string) *RegisterClientInput

SetClientName sets the ClientName field's value.

func (*RegisterClientInput) SetClientType Uses

func (s *RegisterClientInput) SetClientType(v string) *RegisterClientInput

SetClientType sets the ClientType field's value.

func (*RegisterClientInput) SetScopes Uses

func (s *RegisterClientInput) SetScopes(v []*string) *RegisterClientInput

SetScopes sets the Scopes field's value.

func (RegisterClientInput) String Uses

func (s RegisterClientInput) String() string

String returns the string representation

func (*RegisterClientInput) Validate Uses

func (s *RegisterClientInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterClientOutput Uses

type RegisterClientOutput struct {

    // The endpoint where the client can request authorization.
    AuthorizationEndpoint *string `locationName:"authorizationEndpoint" type:"string"`

    // The unique identifier string for each client. This client uses this identifier
    // to get authenticated by the service in subsequent calls.
    ClientId *string `locationName:"clientId" type:"string"`

    // Indicates the time at which the clientId and clientSecret were issued.
    ClientIdIssuedAt *int64 `locationName:"clientIdIssuedAt" type:"long"`

    // A secret string generated for the client. The client will use this string
    // to get authenticated by the service in subsequent calls.
    ClientSecret *string `locationName:"clientSecret" type:"string"`

    // Indicates the time at which the clientId and clientSecret will become invalid.
    ClientSecretExpiresAt *int64 `locationName:"clientSecretExpiresAt" type:"long"`

    // The endpoint where the client can get an access token.
    TokenEndpoint *string `locationName:"tokenEndpoint" type:"string"`
    // contains filtered or unexported fields
}

func (RegisterClientOutput) GoString Uses

func (s RegisterClientOutput) GoString() string

GoString returns the string representation

func (*RegisterClientOutput) SetAuthorizationEndpoint Uses

func (s *RegisterClientOutput) SetAuthorizationEndpoint(v string) *RegisterClientOutput

SetAuthorizationEndpoint sets the AuthorizationEndpoint field's value.

func (*RegisterClientOutput) SetClientId Uses

func (s *RegisterClientOutput) SetClientId(v string) *RegisterClientOutput

SetClientId sets the ClientId field's value.

func (*RegisterClientOutput) SetClientIdIssuedAt Uses

func (s *RegisterClientOutput) SetClientIdIssuedAt(v int64) *RegisterClientOutput

SetClientIdIssuedAt sets the ClientIdIssuedAt field's value.

func (*RegisterClientOutput) SetClientSecret Uses

func (s *RegisterClientOutput) SetClientSecret(v string) *RegisterClientOutput

SetClientSecret sets the ClientSecret field's value.

func (*RegisterClientOutput) SetClientSecretExpiresAt Uses

func (s *RegisterClientOutput) SetClientSecretExpiresAt(v int64) *RegisterClientOutput

SetClientSecretExpiresAt sets the ClientSecretExpiresAt field's value.

func (*RegisterClientOutput) SetTokenEndpoint Uses

func (s *RegisterClientOutput) SetTokenEndpoint(v string) *RegisterClientOutput

SetTokenEndpoint sets the TokenEndpoint field's value.

func (RegisterClientOutput) String Uses

func (s RegisterClientOutput) String() string

String returns the string representation

type SSOOIDC Uses

type SSOOIDC struct {
    *client.Client
}

SSOOIDC provides the API operation methods for making requests to AWS SSO OIDC. See this package's package overview docs for details on the service.

SSOOIDC methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New Uses

func New(p client.ConfigProvider, cfgs ...*aws.Config) *SSOOIDC

New creates a new instance of the SSOOIDC client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a SSOOIDC client from just a session.
svc := ssooidc.New(mySession)

// Create a SSOOIDC client with additional configuration
svc := ssooidc.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*SSOOIDC) CreateToken Uses

func (c *SSOOIDC) CreateToken(input *CreateTokenInput) (*CreateTokenOutput, error)

CreateToken API operation for AWS SSO OIDC.

Creates and returns an access token for the authorized client. The access token issued will be used to fetch short-term credentials for the assigned roles in the AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SSO OIDC's API operation CreateToken for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
Indicates that something is wrong with the input to the request. For example,
a required parameter might be missing or out of range.

* ErrCodeInvalidClientException "InvalidClientException"
Indicates that the clientId or clientSecret in the request is invalid. For
example, this can occur when a client sends an incorrect clientId or an expired
clientSecret.

* ErrCodeInvalidGrantException "InvalidGrantException"
Indicates that a request contains an invalid grant. This can occur if a client
makes a CreateToken request with an invalid grant type.

* ErrCodeUnauthorizedClientException "UnauthorizedClientException"
Indicates that the client is not currently authorized to make the request.
This can happen when a clientId is not issued for a public client.

* ErrCodeUnsupportedGrantTypeException "UnsupportedGrantTypeException"
Indicates that the grant type in the request is not supported by the service.

* ErrCodeInvalidScopeException "InvalidScopeException"
Indicates that the scope provided in the request is invalid.

* ErrCodeAuthorizationPendingException "AuthorizationPendingException"
Indicates that a request to authorize a client with an access user session
token is pending.

* ErrCodeSlowDownException "SlowDownException"
Indicates that the client is making the request too frequently and is more
than the service can handle.

* ErrCodeAccessDeniedException "AccessDeniedException"
You do not have sufficient access to perform this action.

* ErrCodeExpiredTokenException "ExpiredTokenException"
Indicates that the token issued by the service is expired and is no longer
valid.

* ErrCodeInternalServerException "InternalServerException"
Indicates that an error from the service occurred while trying to process
a request.

See also, https://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateToken

func (*SSOOIDC) CreateTokenRequest Uses

func (c *SSOOIDC) CreateTokenRequest(input *CreateTokenInput) (req *request.Request, output *CreateTokenOutput)

CreateTokenRequest generates a "aws/request.Request" representing the client's request for the CreateToken operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateToken for more information on using the CreateToken API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateTokenRequest method.
req, resp := client.CreateTokenRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateToken

func (*SSOOIDC) CreateTokenWithContext Uses

func (c *SSOOIDC) CreateTokenWithContext(ctx aws.Context, input *CreateTokenInput, opts ...request.Option) (*CreateTokenOutput, error)

CreateTokenWithContext is the same as CreateToken with the addition of the ability to pass a context and additional request options.

See CreateToken for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSOOIDC) RegisterClient Uses

func (c *SSOOIDC) RegisterClient(input *RegisterClientInput) (*RegisterClientOutput, error)

RegisterClient API operation for AWS SSO OIDC.

Registers a client with AWS SSO. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SSO OIDC's API operation RegisterClient for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
Indicates that something is wrong with the input to the request. For example,
a required parameter might be missing or out of range.

* ErrCodeInvalidScopeException "InvalidScopeException"
Indicates that the scope provided in the request is invalid.

* ErrCodeInvalidClientMetadataException "InvalidClientMetadataException"
Indicates that the client information sent in the request during registration
is invalid.

* ErrCodeInternalServerException "InternalServerException"
Indicates that an error from the service occurred while trying to process
a request.

See also, https://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/RegisterClient

func (*SSOOIDC) RegisterClientRequest Uses

func (c *SSOOIDC) RegisterClientRequest(input *RegisterClientInput) (req *request.Request, output *RegisterClientOutput)

RegisterClientRequest generates a "aws/request.Request" representing the client's request for the RegisterClient operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterClient for more information on using the RegisterClient API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterClientRequest method.
req, resp := client.RegisterClientRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/RegisterClient

func (*SSOOIDC) RegisterClientWithContext Uses

func (c *SSOOIDC) RegisterClientWithContext(ctx aws.Context, input *RegisterClientInput, opts ...request.Option) (*RegisterClientOutput, error)

RegisterClientWithContext is the same as RegisterClient with the addition of the ability to pass a context and additional request options.

See RegisterClient for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSOOIDC) StartDeviceAuthorization Uses

func (c *SSOOIDC) StartDeviceAuthorization(input *StartDeviceAuthorizationInput) (*StartDeviceAuthorizationOutput, error)

StartDeviceAuthorization API operation for AWS SSO OIDC.

Initiates device authorization by requesting a pair of verification codes from the authorization service.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SSO OIDC's API operation StartDeviceAuthorization for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
Indicates that something is wrong with the input to the request. For example,
a required parameter might be missing or out of range.

* ErrCodeInvalidClientException "InvalidClientException"
Indicates that the clientId or clientSecret in the request is invalid. For
example, this can occur when a client sends an incorrect clientId or an expired
clientSecret.

* ErrCodeUnauthorizedClientException "UnauthorizedClientException"
Indicates that the client is not currently authorized to make the request.
This can happen when a clientId is not issued for a public client.

* ErrCodeSlowDownException "SlowDownException"
Indicates that the client is making the request too frequently and is more
than the service can handle.

* ErrCodeInternalServerException "InternalServerException"
Indicates that an error from the service occurred while trying to process
a request.

See also, https://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/StartDeviceAuthorization

func (*SSOOIDC) StartDeviceAuthorizationRequest Uses

func (c *SSOOIDC) StartDeviceAuthorizationRequest(input *StartDeviceAuthorizationInput) (req *request.Request, output *StartDeviceAuthorizationOutput)

StartDeviceAuthorizationRequest generates a "aws/request.Request" representing the client's request for the StartDeviceAuthorization operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartDeviceAuthorization for more information on using the StartDeviceAuthorization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartDeviceAuthorizationRequest method.
req, resp := client.StartDeviceAuthorizationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/StartDeviceAuthorization

func (*SSOOIDC) StartDeviceAuthorizationWithContext Uses

func (c *SSOOIDC) StartDeviceAuthorizationWithContext(ctx aws.Context, input *StartDeviceAuthorizationInput, opts ...request.Option) (*StartDeviceAuthorizationOutput, error)

StartDeviceAuthorizationWithContext is the same as StartDeviceAuthorization with the addition of the ability to pass a context and additional request options.

See StartDeviceAuthorization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type StartDeviceAuthorizationInput Uses

type StartDeviceAuthorizationInput struct {

    // The unique identifier string for the client that is registered with AWS SSO.
    // This value should come from the persisted result of the RegisterClient API
    // operation.
    //
    // ClientId is a required field
    ClientId *string `locationName:"clientId" type:"string" required:"true"`

    // A secret string that is generated for the client. This value should come
    // from the persisted result of the RegisterClient API operation.
    //
    // ClientSecret is a required field
    ClientSecret *string `locationName:"clientSecret" type:"string" required:"true"`

    // The URL for the AWS SSO user portal. For more information, see Using the
    // User Portal (https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html)
    // in the AWS Single Sign-On User Guide.
    //
    // StartUrl is a required field
    StartUrl *string `locationName:"startUrl" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (StartDeviceAuthorizationInput) GoString Uses

func (s StartDeviceAuthorizationInput) GoString() string

GoString returns the string representation

func (*StartDeviceAuthorizationInput) SetClientId Uses

func (s *StartDeviceAuthorizationInput) SetClientId(v string) *StartDeviceAuthorizationInput

SetClientId sets the ClientId field's value.

func (*StartDeviceAuthorizationInput) SetClientSecret Uses

func (s *StartDeviceAuthorizationInput) SetClientSecret(v string) *StartDeviceAuthorizationInput

SetClientSecret sets the ClientSecret field's value.

func (*StartDeviceAuthorizationInput) SetStartUrl Uses

func (s *StartDeviceAuthorizationInput) SetStartUrl(v string) *StartDeviceAuthorizationInput

SetStartUrl sets the StartUrl field's value.

func (StartDeviceAuthorizationInput) String Uses

func (s StartDeviceAuthorizationInput) String() string

String returns the string representation

func (*StartDeviceAuthorizationInput) Validate Uses

func (s *StartDeviceAuthorizationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartDeviceAuthorizationOutput Uses

type StartDeviceAuthorizationOutput struct {

    // The short-lived code that is used by the device when polling for a session
    // token.
    DeviceCode *string `locationName:"deviceCode" type:"string"`

    // Indicates the number of seconds in which the verification code will become
    // invalid.
    ExpiresIn *int64 `locationName:"expiresIn" type:"integer"`

    // Indicates the number of seconds the client must wait between attempts when
    // polling for a session.
    Interval *int64 `locationName:"interval" type:"integer"`

    // A one-time user verification code. This is needed to authorize an in-use
    // device.
    UserCode *string `locationName:"userCode" type:"string"`

    // The URI of the verification page that takes the userCode to authorize the
    // device.
    VerificationUri *string `locationName:"verificationUri" type:"string"`

    // An alternate URL that the client can use to automatically launch a browser.
    // This process skips the manual step in which the user visits the verification
    // page and enters their code.
    VerificationUriComplete *string `locationName:"verificationUriComplete" type:"string"`
    // contains filtered or unexported fields
}

func (StartDeviceAuthorizationOutput) GoString Uses

func (s StartDeviceAuthorizationOutput) GoString() string

GoString returns the string representation

func (*StartDeviceAuthorizationOutput) SetDeviceCode Uses

func (s *StartDeviceAuthorizationOutput) SetDeviceCode(v string) *StartDeviceAuthorizationOutput

SetDeviceCode sets the DeviceCode field's value.

func (*StartDeviceAuthorizationOutput) SetExpiresIn Uses

func (s *StartDeviceAuthorizationOutput) SetExpiresIn(v int64) *StartDeviceAuthorizationOutput

SetExpiresIn sets the ExpiresIn field's value.

func (*StartDeviceAuthorizationOutput) SetInterval Uses

func (s *StartDeviceAuthorizationOutput) SetInterval(v int64) *StartDeviceAuthorizationOutput

SetInterval sets the Interval field's value.

func (*StartDeviceAuthorizationOutput) SetUserCode Uses

func (s *StartDeviceAuthorizationOutput) SetUserCode(v string) *StartDeviceAuthorizationOutput

SetUserCode sets the UserCode field's value.

func (*StartDeviceAuthorizationOutput) SetVerificationUri Uses

func (s *StartDeviceAuthorizationOutput) SetVerificationUri(v string) *StartDeviceAuthorizationOutput

SetVerificationUri sets the VerificationUri field's value.

func (*StartDeviceAuthorizationOutput) SetVerificationUriComplete Uses

func (s *StartDeviceAuthorizationOutput) SetVerificationUriComplete(v string) *StartDeviceAuthorizationOutput

SetVerificationUriComplete sets the VerificationUriComplete field's value.

func (StartDeviceAuthorizationOutput) String Uses

func (s StartDeviceAuthorizationOutput) String() string

String returns the string representation

Directories

PathSynopsis
ssooidcifacePackage ssooidciface provides an interface to enable mocking the AWS SSO OIDC service client for testing your code.

Package ssooidc imports 8 packages (graph) and is imported by 3 packages. Updated 2019-11-19. Refresh now. Tools for package owners.