Client: Aws\SSO\SSOClient

Service ID: sso

Version: 2019-06-10

This page describes the parameters and results for the operations of the AWS Single Sign-On (2019-06-10), and shows how to use the Aws\SSO\SSOClient object to call the described operations. This documentation is specific to the 2019-06-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

GetRoleCredentials ( array $params = [] )

Returns the STS short-term credentials for a given role name that is assigned to the user.

ListAccountRoles ( array $params = [] )

Lists all roles that are assigned to the user for a given AWS account.

ListAccounts ( array $params = [] )

Lists all AWS accounts assigned to the user.

Logout ( array $params = [] )

Removes the locally stored SSO tokens from the client-side cache and sends an API call to the IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in session.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAccountRoles

ListAccounts

$result = $client->getRoleCredentials([/* ... */]);
$promise = $client->getRoleCredentialsAsync([/* ... */]);

$result = $client->getRoleCredentials([
    'accessToken' => '<string>', // REQUIRED
    'accountId' => '<string>', // REQUIRED
    'roleName' => '<string>', // REQUIRED
]);

[
    'roleCredentials' => [
        'accessKeyId' => '<string>',
        'expiration' => <integer>,
        'secretAccessKey' => '<string>',
        'sessionToken' => '<string>',
    ],
]

$result = $client->listAccountRoles([/* ... */]);
$promise = $client->listAccountRolesAsync([/* ... */]);

$result = $client->listAccountRoles([
    'accessToken' => '<string>', // REQUIRED
    'accountId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

[
    'nextToken' => '<string>',
    'roleList' => [
        [
            'accountId' => '<string>',
            'roleName' => '<string>',
        ],
        // ...
    ],
]

$result = $client->listAccounts([/* ... */]);
$promise = $client->listAccountsAsync([/* ... */]);

$result = $client->listAccounts([
    'accessToken' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

[
    'accountList' => [
        [
            'accountId' => '<string>',
            'accountName' => '<string>',
            'emailAddress' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

$result = $client->logout([/* ... */]);
$promise = $client->logoutAsync([/* ... */]);

$result = $client->logout([
    'accessToken' => '<string>', // REQUIRED
]);

[]