< Back
Get-AwsIbmSamlRoles
Post
NAME Get-AwsIbmSamlRoles
SYNOPSIS
Authenticates a user against IBM IAM server to utilize roles granted in AWS via AWS PowerShell cmdlets.
SYNTAX
Get-AwsIbmSamlRoles -EndpointName <string> [-AwsAccountId <string[]>] [-Credential <PSCredential>] [-ErrorClass
<string>] [-ErrorElement <string>] [-ProxyAddress <Uri>] [-ProxyBypassList <string[]>] [-ProxyBypassOnLocal
<SwitchParameter>] [-ProxyCredentials <ICredentials>] [-SecurityProtocol {SystemDefault | Ssl3 | Tls | Tls11 |
Tls12 | Tls13}] [-STSEndpointRegion <string>] [<CommonParameters>]
DESCRIPTION
Authenticates a user against IBM IAM server to utilize roles granted in AWS via AWS PowerShell cmdlets.
PARAMETERS
-EndpointName <string>
The name of the endpoint you gave when calling Set-AWSSamlEndpoint with your URL to the IBM IAM server.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Credential <PSCredential>
The credentials you want to use to auto-login to the IBM IAM server.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AwsAccountId <string[]>
AWS account id to filter out roles only in a specific account.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SecurityProtocol <SecurityProtocolType>
Set what Security Protocol to use when connecting over HTTPS. Default: TLS 1.2
Possible values: SystemDefault, Ssl3, Tls, Tls11, Tls12, Tls13
Required? false
Position? named
Default value Tls12
Accept pipeline input? false
Accept wildcard characters? false
-ErrorElement <string>
Set what HTML element will contain a error response if there is a error from bad login. Default: P
Required? false
Position? named
Default value p
Accept pipeline input? false
Accept wildcard characters? false
-ErrorClass <string>
Set what HTML class the ErrorElement will contain for a error response if there is a error from bad login.
Default: error
Required? false
Position? named
Default value error
Accept pipeline input? false
Accept wildcard characters? false
-STSEndpointRegion <string>
Region to use when calling SecurityTokenService's AssumeRoleWithSAML. Default: us-east-2
Required? false
Position? named
Default value us-east-2
Accept pipeline input? false
Accept wildcard characters? false
-ProxyAddress <Uri>
The address of the proxy in Url form. (https://proxy.example.corp:8080)
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProxyCredentials <ICredentials>
The credentials of the web proxy.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProxyBypassOnLocal <SwitchParameter>
Indicates whether to bypass the proxy server for local addresses.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ProxyBypassList <string[]>
A address that does not use the proxy server.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
The name of the endpoint you gave when calling Set-AWSSamlEndpoint with your URL to the IBM IAM server.
OUTPUTS
IBM.IAM.AWS.SecurityToken.SAML.SAMLCredential
AWS Principal and Role ARNs
---------- EXAMPLE 1 ----------
$endpoint = 'https://sso.mycompany.com/saml20/logininitial'
Set-AWSSamlEndpoint -Endpoint $endpoint -StoreAs 'IBMEP'
Get-AwsIbmSamlRoles -EndpointName 'IBMEP'
---------- EXAMPLE 2 ----------
$endpoint = 'https://sso.mycompany.com/saml20/logininitial'
Set-AWSSamlEndpoint -Endpoint $endpoint -StoreAs 'IBMEP'
Get-AwsIbmSamlRoles -EndpointName 'IBMEP' -Credential (Get-Credential -UserName 'MyUsername' -Message 'IBM IAM
SAML Server')
RELATED LINKS
SYNOPSIS
Authenticates a user against IBM IAM server to utilize roles granted in AWS via AWS PowerShell cmdlets.
SYNTAX
Get-AwsIbmSamlRoles -EndpointName <string> [-AwsAccountId <string[]>] [-Credential <PSCredential>] [-ErrorClass
<string>] [-ErrorElement <string>] [-ProxyAddress <Uri>] [-ProxyBypassList <string[]>] [-ProxyBypassOnLocal
<SwitchParameter>] [-ProxyCredentials <ICredentials>] [-SecurityProtocol {SystemDefault | Ssl3 | Tls | Tls11 |
Tls12 | Tls13}] [-STSEndpointRegion <string>] [<CommonParameters>]
DESCRIPTION
Authenticates a user against IBM IAM server to utilize roles granted in AWS via AWS PowerShell cmdlets.
PARAMETERS
-EndpointName <string>
The name of the endpoint you gave when calling Set-AWSSamlEndpoint with your URL to the IBM IAM server.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Credential <PSCredential>
The credentials you want to use to auto-login to the IBM IAM server.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AwsAccountId <string[]>
AWS account id to filter out roles only in a specific account.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SecurityProtocol <SecurityProtocolType>
Set what Security Protocol to use when connecting over HTTPS. Default: TLS 1.2
Possible values: SystemDefault, Ssl3, Tls, Tls11, Tls12, Tls13
Required? false
Position? named
Default value Tls12
Accept pipeline input? false
Accept wildcard characters? false
-ErrorElement <string>
Set what HTML element will contain a error response if there is a error from bad login. Default: P
Required? false
Position? named
Default value p
Accept pipeline input? false
Accept wildcard characters? false
-ErrorClass <string>
Set what HTML class the ErrorElement will contain for a error response if there is a error from bad login.
Default: error
Required? false
Position? named
Default value error
Accept pipeline input? false
Accept wildcard characters? false
-STSEndpointRegion <string>
Region to use when calling SecurityTokenService's AssumeRoleWithSAML. Default: us-east-2
Required? false
Position? named
Default value us-east-2
Accept pipeline input? false
Accept wildcard characters? false
-ProxyAddress <Uri>
The address of the proxy in Url form. (https://proxy.example.corp:8080)
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProxyCredentials <ICredentials>
The credentials of the web proxy.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProxyBypassOnLocal <SwitchParameter>
Indicates whether to bypass the proxy server for local addresses.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ProxyBypassList <string[]>
A address that does not use the proxy server.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
The name of the endpoint you gave when calling Set-AWSSamlEndpoint with your URL to the IBM IAM server.
OUTPUTS
IBM.IAM.AWS.SecurityToken.SAML.SAMLCredential
AWS Principal and Role ARNs
---------- EXAMPLE 1 ----------
$endpoint = 'https://sso.mycompany.com/saml20/logininitial'
Set-AWSSamlEndpoint -Endpoint $endpoint -StoreAs 'IBMEP'
Get-AwsIbmSamlRoles -EndpointName 'IBMEP'
---------- EXAMPLE 2 ----------
$endpoint = 'https://sso.mycompany.com/saml20/logininitial'
Set-AWSSamlEndpoint -Endpoint $endpoint -StoreAs 'IBMEP'
Get-AwsIbmSamlRoles -EndpointName 'IBMEP' -Credential (Get-Credential -UserName 'MyUsername' -Message 'IBM IAM
SAML Server')
RELATED LINKS