GS2-Auth

Create Client

auth_client = client('auth')

Method

create_once_onetime_token

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

実行回数制限付きワンタイムトークンを発行します

Request

{
  scriptName=string,
  args=table,
  grant=string,
}
  • scriptName
  • [string] 認可処理に実行するスクリプト
  • args
  • [table] grant で指定したアクションに引数として渡すことを許可する内容
  • grant
  • [string] 認可するアクション

Response

  • token
  • [string] アクセストークン

create_time_onetime_token

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

1回のみ実行を許可するワンタイムトークンを発行します このトークンはスタミナの回復処理など、有効期間内だからといって何度も実行されたくない処理を1度だけ許可したい場合に発行します。

Request

{
  scriptName=string,
}
  • scriptName
  • [string] 認可スクリプトを指定します

Response

  • token
  • [string] アクセストークン
  • expire
  • [number] アクセストークンの有効期限

login

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

ログイン処理を実行します

Request

{
  serviceId=string,
  userId=string,
}
  • serviceId
  • [string] ログインするサービスID
  • userId
  • [string] ログインするユーザのID

Response

  • token
  • [string] アクセストークン
  • serviceId
  • [string] サービスID
  • userId
  • [string] ユーザID
  • expire
  • [number] アクセストークンの有効期限

login_with_sign

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

GS2-Accountの認証署名付きログイン処理を実行します

Request

{
  serviceId=string,
  userId=string,
  keyName=string,
  sign=string,
}
  • serviceId
  • [string] ログインするサービスID
  • userId
  • [string] ログインするユーザのIDを指定してください
  • keyName
  • [string] GS2-Accountの認証署名の作成に使用した GS2-Key の暗号鍵名
  • sign
  • [string] GS2-Accountの認証署名

Response

  • token
  • [string] アクセストークン
  • serviceId
  • [string] サービスID
  • userId
  • [string] ユーザID
  • expire
  • [number] アクセストークンの有効期限