Methods summary
public
|
#
__construct( string $region, GS2\Core\Gs2Credentials $credentials, array $options = [] )
コンストラクタ
Parameters
- $region
- リージョン名
- $credentials
- 認証情報
- $options
- オプション
|
public
array
|
#
describeUser( string $pageToken = NULL, integer $limit = NULL )
ユーザリストを取得
Parameters
- $pageToken
- ページトークン
- $limit
- 取得件数
Returns
array
- items
- array
- userId => ユーザID
- ownerId => オーナーID
- name => ユーザ名
- createAt => 作成日時
- nextPageToken => 次ページトークン
|
public
array
|
#
createUser( array $request )
ユーザを作成
GS2のサービスを利用するにはユーザを作成する必要があります。
ユーザを作成後、ユーザに対して権限設定を行い、ユーザに対応したGSI(クライアントID/シークレット)を発行することでAPIが利用できるようになります。
ユーザを作成
GS2のサービスを利用するにはユーザを作成する必要があります。
ユーザを作成後、ユーザに対して権限設定を行い、ユーザに対応したGSI(クライアントID/シークレット)を発行することでAPIが利用できるようになります。
Parameters
Returns
array
- item
- userId => ユーザID
- ownerId => オーナーID
- name => ユーザ名
- createAt => 作成日時
|
public
array
|
#
getUser( array $request )
ユーザを取得
Parameters
Returns
array
- item
- userId => ユーザID
- ownerId => オーナーID
- name => ユーザ名
- createAt => 作成日時
|
public
|
|
public
array
|
#
describeIdentifier( array $request, string $pageToken = NULL, integer $limit = NULL )
GSIリストを取得
Parameters
- $request
- $pageToken
- ページトークン
- $limit
- 取得件数
Returns
array
- items
- array
- identifierId => GSIID
- ownerId => オーナーID
- clientId => クライアントID
- createAt => 作成日時
- nextPageToken => 次ページトークン
|
public
array
|
#
createIdentifier( array $request )
GSIを作成
GSIはSDKなどでAPIを利用する際に必要となる クライアントID/シークレット です。
AWSでいうIAMのクレデンシャルに相当します。
GSIを作成
GSIはSDKなどでAPIを利用する際に必要となる クライアントID/シークレット です。
AWSでいうIAMのクレデンシャルに相当します。
Parameters
Returns
array
- item
- identifierId => GSIID
- ownerId => オーナーID
- clientId => クライアントID
- clientSecret => クライアントシークレット
- createAt => 作成日時
|
public
|
#
deleteIdentifier( array $request )
GSIを削除
Parameters
- $request
- userName => ユーザ名
- identifierId => GSI ID
|
public
array
|
#
getHasSecurityPolicy( array $request )
ユーザが保持しているセキュリティポリシー一覧を取得
ユーザが保持しているセキュリティポリシー一覧を取得
Parameters
Returns
array
- items
- array
- identifierId => GSIID
- ownerId => オーナーID
- clientId => クライアントID
- createAt => 作成日時
|
public
|
#
attachSecurityPolicy( array $request )
ユーザにセキュリティポリシーを割り当てる
Parameters
- $request
- userName => ユーザ名
- securityPolicyId => セキュリティポリシーID
|
public
|
#
detachSecurityPolicy( array $request )
ユーザに割り当てられたセキュリティポリシーを解除
Parameters
- $request
- userName => ユーザ名
- securityPolicyId => セキュリティポリシーID
|
public
array
|
#
describeSecurityPolicy( string $pageToken = NULL, integer $limit = NULL )
セキュリティポリシーリストを取得
Parameters
- $pageToken
- ページトークン
- $limit
- 取得件数
Returns
array
- items
- array
- securityPolicyId => セキュリティポリシーID
- ownerId => オーナーID
- name => セキュリティポリシー名
- policy => ポリシー
- createAt => 作成日時
- updateAt => 更新日時
- nextPageToken => 次ページトークン
|
public
array
|
#
describeCommonSecurityPolicy( string $pageToken = NULL, integer $limit = NULL )
共用セキュリティポリシーリストを取得
Parameters
- $pageToken
- ページトークン
- $limit
- 取得件数
Returns
array
- items
- array
- securityPolicyId => セキュリティポリシーID
- ownerId => オーナーID
- name => セキュリティポリシー名
- policy => ポリシー
- createAt => 作成日時
- updateAt => 更新日時
- nextPageToken => 次ページトークン
|
public
array
|
#
createSecurityPolicy( array $request )
セキュリティポリシーを作成
セキュリティポリシーはユーザの権限を定義したものです。
AWSのIAMポリシーに似せて設計されていますが、いくつかAWSのIAMポリシーと比較して劣る点があります。
2016/9 時点では以下の様な点が IAMポリシー とは異なります。
- リソースに対するアクセス制御はできません。
- アクションのワイルドカードは最後に1箇所のみ利用できます。
セキュリティポリシーを作成
セキュリティポリシーはユーザの権限を定義したものです。
AWSのIAMポリシーに似せて設計されていますが、いくつかAWSのIAMポリシーと比較して劣る点があります。
2016/9 時点では以下の様な点が IAMポリシー とは異なります。
- リソースに対するアクセス制御はできません。
- アクションのワイルドカードは最後に1箇所のみ利用できます。
Parameters
- $request
- name => セキュリティポリシー名
- policy => ポリシー
Returns
array
- item
- securityPolicyId => セキュリティポリシーID
- ownerId => オーナーID
- name => セキュリティポリシー名
- policy => ポリシー
- createAt => 作成日時
- updateAt => 更新日時
|
public
array
|
#
getSecurityPolicy( array $request )
セキュリティポリシーを取得
Parameters
- $request
- securityPolicyName => セキュリティポリシー名
Returns
array
- item
- securityPolicyId => セキュリティポリシーID
- ownerId => オーナーID
- name => セキュリティポリシー名
- policy => ポリシー
- createAt => 作成日時
- updateAt => 更新日時
|
public
array
|
#
updateSecurityPolicy( array $request )
セキュリティポリシーを更新
Parameters
- $request
- securityPolicyName => セキュリティポリシー名
Returns
array
- item
- securityPolicyId => セキュリティポリシーID
- ownerId => オーナーID
- name => セキュリティポリシー名
- policy => ポリシー
- createAt => 作成日時
- updateAt => 更新日時
|
public
|
#
deleteSecurityPolicy( array $request )
セキュリティポリシーを削除
Parameters
- $request
- securityPolicyName => セキュリティポリシー名
|