Role への Entity の割り当て
- 印刷する
- PDF
Role への Entity の割り当て
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Roleに Entity(Server、Account)を割り当てます。
API
- POST /roles/{roleNo}/entities
リクエスト
Path Variables
パラメータ | 要否 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
roleNo | Y | String | Role No |
Body
{
"roleEntityList": [
{
"id": "string",
"type": "string"
}
]
}
パラメータ | 要否 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
roleEntityList | Y | array | Role Entityリスト | |
roleEntityList.id | N | string | ||
roleEntityList.type | N | string | Server, Service | |
roleEntityList.entityId | N | integer | Deprecated | |
roleEntityList.entityType | N | string | Deprecated |
レスポンス
- レスポンス
パラメータ名 | 要否 | タイプ | 説明 |
---|---|---|---|
ProcessResult | Y | Array | 処理結果 |
- レスポンス例 - 成功
[
{
"id": "entityId",
"name": "addEntity",
"success": true
}
]
- レスポンス例 - user所有ではない entity
[
{
"success": false,
"id": "entityId",
"message": "アカウント所有のエンティティではありません。"
}
]
- レスポンス例 - 既に登録済みの entity
[
{
"success": false,
"id": "entityId",
"message": "既に登録済みのエンティティです。"
}
]
エラー
以下のエラーコードは、このアクション(Action)で発生する特徴的なエラーです。エラーレスポンス形式は ErrorResponseをご参照ください。
共通して発生するエラーについての詳細は、NAVER Cloud Platform APIをご参照ください。
HTTP status code | エラーコード | エラーメッセージ |
---|---|---|
401 | 30 | 不正な roleNo |
404 | 910 | RoleTypeに合わないエンティティあり |
API
- POST /roles/{roleNo}/entities/account
リクエスト
Path Variables
パラメータ | 要否 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
roleNo | Y | String | Role No |
Body
{
"isMyAccount" : "boolean",
"accountName" : "string",
"loginId": "string"
}
パラメータ | 要否 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
isMyAccount | Y | boolean | 本人アカウント(true)、他のメインアカウント(false) | |
accountName | N | string | ユーザー名 | |
loginId | N | string | ログイン ID |
レスポンス
- レスポンス
パラメータ名 | 要否 | タイプ | 説明 |
---|---|---|---|
ProcessResult | Y | Array | 処理結果 |
- レスポンス例 - 成功
{
"success": true
}
エラー
以下のエラーコードは、このアクション(Action)で発生する特徴的なエラーです。エラーレスポンス形式は ErrorResponseをご参照ください。
共通して発生するエラーについての詳細は、NAVER Cloud Platform APIをご参照ください。
HTTP status code | エラーコード | エラーメッセージ |
---|---|---|
401 | 30 | 不正な roleNo |
400 | 400 | isMyAccountが欠落 |
400 | 400 | 入力した値が無効 |
400 | 9001 | アカウント名の入力が必要 |
400 | 9001 | ログイン IDの入力が必要 |
この記事は役に立ちましたか?