View on GitHub
SSOOIDC Structure Reference
SSOOIDC
public struct SSOOIDCClient object for interacting with AWS SSOOIDC service.
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). For general information about AWS SSO, see What is AWS Single Sign-On? 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.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the SSOOIDC client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
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.
Declaration
Swift
public func createToken(_ input: CreateTokenRequest) -> EventLoopFuture<CreateTokenResponse> -
Registers a client with AWS SSO. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.
Declaration
Swift
public func registerClient(_ input: RegisterClientRequest) -> EventLoopFuture<RegisterClientResponse> -
Initiates device authorization by requesting a pair of verification codes from the authorization service.
Declaration
Swift
public func startDeviceAuthorization(_ input: StartDeviceAuthorizationRequest) -> EventLoopFuture<StartDeviceAuthorizationResponse>