GS2-Identifier

Create Client

identifier_client = client('identifier')

Method

attach_security_policy

response = identifier_client:attach_security_policy(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ユーザにセキュリティポリシーを割り当てます

Request

{
  userName=string,
  securityPolicyId=string,
}
  • userName
  • [string] ユーザの名前を指定します。
  • securityPolicyId
  • [string] セキュリティポリシーのGRN

Response

None

create_identifier

response = identifier_client:create_identifier(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

GSIを新規作成します

Request

{
  userName=string,
}
  • userName
  • [string] ユーザの名前

Response

  • item
  • [FullIdentifier] ユーザ

create_security_policy

response = identifier_client:create_security_policy(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

セキュリティポリシーを新規作成します

Request

{
  policy=string,
  name=string,
}
  • policy
  • [string] ポリシードキュメント
  • name
  • [string] 名前

Response

  • item
  • [SecurityPolicy] セキュリティポリシー

create_user

response = identifier_client:create_user(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ユーザを新規作成します

Request

{
  name=string,
}
  • name
  • [string] ユーザの名前

Response

  • item
  • [User] ユーザ

delete_identifier

response = identifier_client:delete_identifier(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

GSIを削除します

Request

{
  userName=string,
  identifierId=string,
}
  • userName
  • [string] ユーザの名前
  • identifierId
  • [string] GSIのGRN

Response

None

delete_security_policy

response = identifier_client:delete_security_policy(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

セキュリティポリシーを削除します

Request

{
  securityPolicyName=string,
}
  • securityPolicyName
  • [string] セキュリティポリシーの名前を指定します。

Response

None

delete_user

response = identifier_client:delete_user(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ユーザを削除します

Request

{
  userName=string,
}
  • userName
  • [string] ユーザの名前

Response

None

describe_common_security_policy

response = identifier_client:describe_common_security_policy(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

共用セキュリティポリシーの一覧を取得します

Request

{
  pageToken=string,
  limit=number,
}
  • pageToken
  • [string] データの取得を開始する位置を指定するトークン
  • limit
  • [number] データの取得件数

Response

  • nextPageToken
  • [string] 次のページを読み込むためのトークン
  • items
  • [table<SecurityPolicy>] セキュリティポリシー

describe_identifier

response = identifier_client:describe_identifier(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

GSIの一覧を取得します

Request

{
  userName=string,
  pageToken=string,
  limit=number,
}
  • userName
  • [string] ユーザの名前
  • pageToken
  • [string] データの取得を開始する位置を指定するトークン
  • limit
  • [number] データの取得件数

Response

  • nextPageToken
  • [string] 次のページを読み込むためのトークン
  • items
  • [table<Identifier>] ユーザ

describe_security_policy

response = identifier_client:describe_security_policy(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

セキュリティポリシーの一覧を取得します

Request

{
  pageToken=string,
  limit=number,
}
  • pageToken
  • [string] データの取得を開始する位置を指定するトークン
  • limit
  • [number] データの取得件数

Response

  • nextPageToken
  • [string] 次のページを読み込むためのトークン
  • items
  • [table<SecurityPolicy>] セキュリティポリシー

describe_user

response = identifier_client:describe_user(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ユーザの一覧を取得します

Request

{
  pageToken=string,
  limit=number,
}
  • pageToken
  • [string] データの取得を開始する位置を指定するトークン
  • limit
  • [number] データの取得件数

Response

  • nextPageToken
  • [string] 次のページを読み込むためのトークン
  • items
  • [table<User>] ユーザ

detach_security_policy

response = identifier_client:detach_security_policy(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ユーザに割り当てられたセキュリティポリシーを解除します

Request

{
  userName=string,
  securityPolicyId=string,
}
  • userName
  • [string] ユーザの名前
  • securityPolicyId
  • [string] セキュリティポリシーGRN

Response

None

get_has_security_policy

response = identifier_client:get_has_security_policy(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ユーザが保持しているセキュリティポリシー一覧を取得します

Request

{
  userName=string,
}
  • userName
  • [string] ユーザの名前

Response

  • nextPageToken
  • [string] 次のページを読み込むためのトークン
  • items
  • [table<SecurityPolicy>] セキュリティポリシー

get_identifier

response = identifier_client:get_identifier(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

GSIを取得します。

Request

{
  userName=string,
  identifierId=string,
}
  • userName
  • [string] ユーザの名前
  • identifierId
  • [string] GSIのGRN

Response

  • item
  • [Identifier] ユーザ

get_security_policy

response = identifier_client:get_security_policy(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

セキュリティポリシーを取得します

Request

{
  securityPolicyName=string,
}
  • securityPolicyName
  • [string] セキュリティポリシーの名前を指定します。

Response

  • item
  • [SecurityPolicy] セキュリティポリシー

get_user

response = identifier_client:get_user(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ユーザを取得します。

Request

{
  userName=string,
}
  • userName
  • [string] ユーザの名前

Response

  • item
  • [User] ユーザ

update_security_policy

response = identifier_client:update_security_policy(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

セキュリティポリシーを更新します

Request

{
  securityPolicyName=string,
  policy=string,
}
  • securityPolicyName
  • [string] セキュリティポリシーの名前を指定します。
  • policy
  • [string] ポリシードキュメント

Response

  • item
  • [SecurityPolicy] セキュリティポリシー

Model

Identifier

  • ownerId
  • [string] オーナーID
  • createAt
  • [number] 作成日時(エポック秒)
  • userId
  • [string] ユーザID
  • identifierId
  • [string] ユーザGRN
  • clientId
  • [string] クライアントID

FullIdentifier

  • clientSecret
  • [string] クライアントシークレット
  • createAt
  • [number] 作成日時(エポック秒)
  • identifierId
  • [string] ユーザGRN
  • ownerId
  • [string] オーナーID
  • userId
  • [string] ユーザID
  • clientId
  • [string] クライアントID

User

  • ownerId
  • [string] オーナーID
  • createAt
  • [number] 作成日時(エポック秒)
  • userId
  • [string] ユーザGRN
  • name
  • [string] ユーザ名

SecurityPolicy

  • createAt
  • [number] 作成日時(エポック秒)
  • name
  • [string] セキュリティポリシー名
  • securityPolicyId
  • [string] セキュリティポリシーID
  • policy
  • [string] ポリシードキュメント
  • ownerId
  • [string] オーナーID
  • updateAt
  • [number] 最終更新日時(エポック秒)