View on GitHub
SSO Structure Reference
SSO
public struct SSOClient object for interacting with AWS SSO service.
AWS Single Sign-On Portal is a web service that makes it easy for you to assign user access to AWS SSO resources such as the user portal. Users can get AWS account applications and roles assigned to them and get federated into the application. 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 Portal 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, or 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 SSO 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.
-
Returns the STS short-term credentials for a given role name that is assigned to the user.
Declaration
Swift
public func getRoleCredentials(_ input: GetRoleCredentialsRequest) -> EventLoopFuture<GetRoleCredentialsResponse> -
Lists all roles that are assigned to the user for a given AWS account.
Declaration
Swift
public func listAccountRoles(_ input: ListAccountRolesRequest) -> EventLoopFuture<ListAccountRolesResponse> -
Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the administrator of the account. For more information, see Assign User Access in the AWS SSO User Guide. This operation returns a paginated response.
Declaration
Swift
public func listAccounts(_ input: ListAccountsRequest) -> EventLoopFuture<ListAccountsResponse> -
Removes the client- and server-side session that is associated with the user.
Declaration
Swift
@discardableResult public func logout(_ input: LogoutRequest) -> EventLoopFuture<Void>
-
Lists all roles that are assigned to the user for a given AWS account.
Declaration
Swift
public func listAccountRolesPaginator(_ input: ListAccountRolesRequest, onPage: @escaping (ListAccountRolesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the administrator of the account. For more information, see Assign User Access in the AWS SSO User Guide. This operation returns a paginated response.
Declaration
Swift
public func listAccountsPaginator(_ input: ListAccountsRequest, onPage: @escaping (ListAccountsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct ListAccountRolesRequest : AWSShapeextension SSO.ListAccountRolesRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListAccountsRequest : AWSShapeextension SSO.ListAccountsRequest: AWSPaginateStringToken