POSTAPIの概要 実装を見る
No description provided.
Credential required: Yes
パラメータ
名前 | 型 | 既定値 |
---|
必須 | roleId | 文字列 | - |
必須 | name | 文字列 | - |
必須 | description | 文字列 | - |
任意必須 | color | 文字列 | - |
任意必須 | iconUrl | 文字列 | - |
必須 | target | 文字列 | - |
必須 | condFormula | オブジェクト | - |
必須 | isPublic | 真偽値 | - |
必須 | isModerator | 真偽値 | - |
必須 | isAdministrator | 真偽値 | - |
| isExplorable | 真偽値 | - |
必須 | asBadge | 真偽値 | - |
必須 | canEditMembersByModerator | 真偽値 | - |
必須 | displayOrder | 数字 | - |
必須 | policies | オブジェクト | - |
204 レスポンス リクエスト成功(内容なし)
400 エラー クライアント側エラー
401 エラー 認証エラー
403 エラー 権限関連のエラー
418 エラー I'm Ai
500 エラー サーバー内部エラー
{
"_path": "/api-docs/endpoints/admin/roles/update",
"_dir": "roles",
"_draft": false,
"_partial": false,
"_locale": "",
"data": {
"post": {
"operationId": "admin/roles/update",
"summary": "admin/roles/update",
"description": "No description provided.\n\n**Credential required**: *Yes*",
"externalDocs": {
"description": "Source code",
"url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/roles/update.ts"
},
"tags": [
"admin"
],
"security": [
{
"ApiKeyAuth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"roleId": {
"type": "string",
"format": "misskey:id"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
},
"iconUrl": {
"type": "string",
"nullable": true
},
"target": {
"type": "string",
"enum": [
"manual",
"conditional"
]
},
"condFormula": {
"type": "object"
},
"isPublic": {
"type": "boolean"
},
"isModerator": {
"type": "boolean"
},
"isAdministrator": {
"type": "boolean"
},
"isExplorable": {
"type": "boolean"
},
"asBadge": {
"type": "boolean"
},
"canEditMembersByModerator": {
"type": "boolean"
},
"displayOrder": {
"type": "number"
},
"policies": {
"type": "object"
}
},
"required": [
"roleId",
"name",
"description",
"color",
"iconUrl",
"target",
"condFormula",
"isPublic",
"isModerator",
"isAdministrator",
"asBadge",
"canEditMembersByModerator",
"displayOrder",
"policies"
]
}
}
}
},
"responses": {
"204": {
"description": "OK (without any results)"
},
"400": {
"description": "Client error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"NO_SUCH_ROLE": {
"value": {
"error": {
"message": "No such role.",
"code": "NO_SUCH_ROLE",
"id": "cd23ef55-09ad-428a-ac61-95a45e124b32"
}
}
},
"INVALID_PARAM": {
"value": {
"error": {
"message": "Invalid param.",
"code": "INVALID_PARAM",
"id": "3d81ceae-475f-4600-b2a8-2bc116157532"
}
}
}
}
}
}
},
"401": {
"description": "Authentication error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"CREDENTIAL_REQUIRED": {
"value": {
"error": {
"message": "Credential required.",
"code": "CREDENTIAL_REQUIRED",
"id": "1384574d-a912-4b81-8601-c7b1c4085df1"
}
}
}
}
}
}
},
"403": {
"description": "Forbidden error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"AUTHENTICATION_FAILED": {
"value": {
"error": {
"message": "Authentication failed. Please ensure your token is correct.",
"code": "AUTHENTICATION_FAILED",
"id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14"
}
}
}
}
}
}
},
"418": {
"description": "I'm Ai",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"I_AM_AI": {
"value": {
"error": {
"message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.",
"code": "I_AM_AI",
"id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84"
}
}
}
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"INTERNAL_ERROR": {
"value": {
"error": {
"message": "Internal error occurred. Please contact us if the error persists.",
"code": "INTERNAL_ERROR",
"id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac"
}
}
}
}
}
}
}
}
}
},
"title": "admin/roles/update",
"_id": "content:api-docs:endpoints:admin:roles:update.json",
"_type": "json",
"_source": "content",
"_file": "api-docs/endpoints/admin/roles/update.json",
"_extension": "json"
}