HumHub Documentation (unofficial)

AssumeRoleWithWebIdentityRequest extends Input
in package

FinalYes

Representation of a AWS Request.

Table of Contents

Properties

$region  : string|null
$durationSeconds  : int|null
The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role [^1] in the *IAM User Guide*.
$policy  : string|null
An IAM policy in JSON format that you want to use as an inline session policy.
$policyArns  : array<string|int, PolicyDescriptorType>|null
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
$providerId  : string|null
The fully qualified host component of the domain name of the OAuth 2.0 identity provider. Do not specify this value for an OpenID Connect identity provider.
$roleArn  : string|null
The Amazon Resource Name (ARN) of the role that the caller is assuming.
$roleSessionName  : string|null
An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the `AssumedRoleUser` response element.
$webIdentityToken  : string|null
The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an `AssumeRoleWithWebIdentity` call. Only tokens with RSA algorithms (RS256) are supported.

Methods

__construct()  : mixed
create()  : self
getDurationSeconds()  : int|null
getPolicy()  : string|null
getPolicyArns()  : array<string|int, PolicyDescriptorType>
getProviderId()  : string|null
getRegion()  : string|null
getRoleArn()  : string|null
getRoleSessionName()  : string|null
getWebIdentityToken()  : string|null
request()  : Request
setDurationSeconds()  : self
setPolicy()  : self
setPolicyArns()  : self
setProviderId()  : self
setRegion()  : void
setRoleArn()  : self
setRoleSessionName()  : self
setWebIdentityToken()  : self
requestBody()  : array<string|int, mixed>

Properties

$region

public string|null $region

$durationSeconds

The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role [^1] in the *IAM User Guide*.

private int|null $durationSeconds

By default, the value is set to 3600 seconds.

The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the Amazon Web Services Management Console ^2 in the IAM User Guide.

$policy

An IAM policy in JSON format that you want to use as an inline session policy.

private string|null $policy

This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies ^1 in the IAM User Guide.

The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.

An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

$policyArns

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

private array<string|int, PolicyDescriptorType>|null $policyArns

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces ^1 in the Amazon Web Services General Reference.

An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies ^2 in the IAM User Guide.

$providerId

The fully qualified host component of the domain name of the OAuth 2.0 identity provider. Do not specify this value for an OpenID Connect identity provider.

private string|null $providerId

Currently www.amazon.com and graph.facebook.com are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.

Do not specify this value for OpenID Connect ID tokens.

$roleSessionName

An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the `AssumedRoleUser` response element.

private string|null $roleSessionName

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

Tags
required

$webIdentityToken

The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an `AssumeRoleWithWebIdentity` call. Only tokens with RSA algorithms (RS256) are supported.

private string|null $webIdentityToken
Tags
required

Methods

__construct()

public __construct([PolicyDescriptorType|array)[], Policy?: null|string, DurationSeconds?: null|int, '@region'?: string|null} $input = [] ]) : mixed
Parameters
$input : PolicyDescriptorType|array)[], Policy?: null|string, DurationSeconds?: null|int, '@region'?: string|null} = []

getRegion()

public getRegion() : string|null
Return values
string|null

setRegion()

public setRegion(string|null $region) : void
Parameters
$region : string|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results