API Key Custom Role
The custom roles an API key is given. The key holds every permission of the role except those with the Owned scope: a key owns nothing.
مدل API Key Custom Role
ویژگیها
-
- نام
_id- نوع
- Object ID
- توضیحات
-
ID of this object
-
ساخت: ProjectOwner یا ProjectAdmin یا EditProjectApiKeyPermissionsخواندن: ProjectOwner یا ProjectAdmin یا ReadProjectApiKeyبهروزرسانی: ProjectOwner یا ProjectAdmin یا EditProjectApiKeyPermissions
-
- نام
createdAt- نوع
- Date
- توضیحات
-
Date and Time when the object was created.
-
ساخت: ProjectOwner یا ProjectAdmin یا EditProjectApiKeyPermissionsخواندن: ProjectOwner یا ProjectAdmin یا ReadProjectApiKeyبهروزرسانی: ProjectOwner یا ProjectAdmin یا EditProjectApiKeyPermissions
-
- نام
updatedAt- نوع
- Date
- توضیحات
-
Date and Time when the object was updated.
-
ساخت: ProjectOwner یا ProjectAdmin یا EditProjectApiKeyPermissionsخواندن: ProjectOwner یا ProjectAdmin یا ReadProjectApiKeyبهروزرسانی: ProjectOwner یا ProjectAdmin یا EditProjectApiKeyPermissions
-
- نام
project- نوع
- Project
- توضیحات
-
Relation to Project Resource in which this object belongs
-
ساخت: ProjectOwner یا ProjectAdmin یا EditProjectApiKeyPermissionsخواندن: ProjectOwner یا ProjectAdmin یا ReadProjectApiKeyبهروزرسانی: قابل بهروزرسانی نیست
-
- نام
projectId- نوع
- Object ID الزامی
- توضیحات
-
ID of your OneUptime Project in which this object belongs
-
ساخت: ProjectOwner یا ProjectAdmin یا EditProjectApiKeyPermissionsخواندن: ProjectOwner یا ProjectAdmin یا ReadProjectApiKeyبهروزرسانی: قابل بهروزرسانی نیست
-
- نام
apiKey- نوع
- API Key
- توضیحات
-
The API key given the role.
-
ساخت: ProjectOwner یا ProjectAdmin یا EditProjectApiKeyPermissionsخواندن: ProjectOwner یا ProjectAdmin یا ReadProjectApiKeyبهروزرسانی: قابل بهروزرسانی نیست
-
- نام
apiKeyId- نوع
- Object ID الزامی
- توضیحات
-
ID of the API key given the role.
-
ساخت: ProjectOwner یا ProjectAdmin یا EditProjectApiKeyPermissionsخواندن: ProjectOwner یا ProjectAdmin یا ReadProjectApiKeyبهروزرسانی: قابل بهروزرسانی نیست
-
- نام
customRole- نوع
- Custom Role
- توضیحات
-
The custom role given to the API key.
-
ساخت: ProjectOwner یا ProjectAdmin یا EditProjectApiKeyPermissionsخواندن: ProjectOwner یا ProjectAdmin یا ReadProjectApiKeyبهروزرسانی: قابل بهروزرسانی نیست
-
- نام
customRoleId- نوع
- Object ID الزامی
- توضیحات
-
ID of the custom role given to the API key.
-
ساخت: ProjectOwner یا ProjectAdmin یا EditProjectApiKeyPermissionsخواندن: ProjectOwner یا ProjectAdmin یا ReadProjectApiKeyبهروزرسانی: قابل بهروزرسانی نیست
-
- نام
createdByUser- نوع
- User
- توضیحات
-
Relation to User who created this object (if this object was created by a User)
-
ساخت: تولیدشده خودکارخواندن: ProjectOwner یا ProjectAdmin یا ReadProjectApiKeyبهروزرسانی: قابل بهروزرسانی نیست
-
- نام
createdByUserId- نوع
- Object ID
- توضیحات
-
User ID who created this object (if this object was created by a User)
-
ساخت: تولیدشده خودکارخواندن: ProjectOwner یا ProjectAdmin یا ReadProjectApiKeyبهروزرسانی: قابل بهروزرسانی نیست
/api/api-key-custom-role/get-list
فهرست
این نقطه پایانی به شما امکان میدهد فهرست صفحهبندیشدهای از همه API Key Custom Role خود را دریافت کنید. بهصورت پیشفرض حداکثر ده API Key Custom Role در هر صفحه نمایش داده میشود.
پارامترهای اختیاری کوئری
-
- Limit
limit- نوع
- number
- توضیحات
- تعداد اشیایی که باید دریافت شوند. بهصورت پیشفرض ۱۰ است و میتوانید آن را تا ۱۰۰ افزایش دهید
-
- Skip
skip- نوع
- number
- توضیحات
- تعداد اشیایی که باید رد شوند. در صفحهبندی مفید است
بدنه اختیاری درخواست
-
- Query
query- نوع
- query
- توضیحات
- اگر میخواهید روی API Key Custom Role فیلتر بگذارید، میتوانید اینجا یک کوئری مشخص کنید. برای اطلاعات بیشتر، لطفاً نوشتن کوئریها را اینجا ببینید.
-
- Select
select- نوع
- select
- توضیحات
- بهصورت پیشفرض فقط شناسه اشیا را دریافت میکنید؛ برای دریافت فیلدهای بیشتر باید آنها را انتخاب کنید. برای اطلاعات بیشتر، لطفاً نحوه انتخاب فیلدها را اینجا ببینید.
-
- Sort
sort- نوع
- sort
- توضیحات
- اشیا بهصورت پیشفرض بر اساس تاریخ ساخت مرتب میشوند. برای تغییر ترتیب مرتبسازی میتوانید این را بفرستید لطفاً نحوه انتخاب فیلدها را اینجا ببینید.
درخواست فهرست
POST/api/api-key-custom-role/get-list?skip=0&limit=10
Content-Type: application/json ApiKey: YOUR_API_KEY
{
"select": {
"apiKeyId": true,
"customRoleId": true,
"projectId": true,
"apiKey": true,
"createdByUser": true
},
"query": {},
"sort": {
"createdAt": -1
}
}
پاسخ
{
"count": 10,
"limit": 10,
"skip": 0,
"data": [
{
"_id": "359c60d9-def5-4f9b-b412-c983bea6ca72",
"apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
"customRoleId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
"apiKey": "Production API Key",
"createdByUser": "admin@company.com"
},
{
"_id": "e8448149-8cf6-440d-8819-79aa6ebcd40c",
"apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
"customRoleId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
"apiKey": "Production API Key",
"createdByUser": "admin@company.com"
},
{
"_id": "bbb2f851-a09c-454b-a119-92e2a35c10bf",
"apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
"customRoleId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
"apiKey": "Production API Key",
"createdByUser": "admin@company.com"
}
]
}
/api/api-key-custom-role/:id/get-item
دریافت مورد با شناسه
این نقطه پایانی به شما امکان میدهد API Key Custom Role را با شناسه دریافت کنید.
پارامترهای الزامی کوئری
-
- ID
id- نوع
- text
- توضیحات
- شناسه شیء
بدنه اختیاری درخواست
-
- Select
select- نوع
- select
- توضیحات
- بهصورت پیشفرض فقط شناسه اشیا را دریافت میکنید؛ برای دریافت فیلدهای بیشتر باید آنها را انتخاب کنید. برای اطلاعات بیشتر، لطفاً نحوه انتخاب فیلدها را اینجا ببینید.
درخواست دریافت مورد
POST/api/api-key-custom-role/:id/get-item
Content-Type: application/json ApiKey: YOUR_API_KEY
{
"select": {
"apiKeyId": true,
"customRoleId": true,
"projectId": true,
"apiKey": true,
"createdByUser": true
}
}
پاسخ
{
"_id": "359c60d9-def5-4f9b-b412-c983bea6ca72",
"apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
"customRoleId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
"apiKey": "Production API Key",
"createdByUser": "admin@company.com"
}
/api/api-key-custom-role/count
شمارش
این نقطه پایانی به شما امکان میدهد تعداد همه API Key Custom Role خود را دریافت کنید.
بدنه اختیاری درخواست
-
- Query
query- نوع
- query
- توضیحات
- اگر میخواهید روی API Key Custom Role فیلتر بگذارید، میتوانید اینجا یک کوئری مشخص کنید. برای اطلاعات بیشتر، لطفاً نوشتن کوئریها را اینجا ببینید.
درخواست شمارش
POST/api/api-key-custom-role/count
Content-Type: application/json ApiKey: YOUR_API_KEY
{
"query": {}
}
پاسخ
{
"count": 107
}
/api/api-key-custom-role
ساخت API Key Custom Role
این نقطه پایانی به شما امکان میدهد شیء جدیدی بسازید.
بدنه درخواست
-
- Data
data- نوع
- JSON
- توضیحات
- شیء موردنظر برای ساخت بهصورت JSON
درخواست ساخت
POST/api/api-key-custom-role
Content-Type: application/json ApiKey: YOUR_API_KEY
{
"data": {
"apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
"customRoleId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
"apiKey": "Production API Key",
"customRole": "Incident Responder"
}
}
پاسخ
{
"_id": "359c60d9-def5-4f9b-b412-c983bea6ca72",
"apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
"customRoleId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
"apiKey": "Production API Key",
"createdByUser": "admin@company.com"
}
/api/api-key-custom-role/:id
بهروزرسانی با شناسه
این نقطه پایانی به شما امکان میدهد شیء را با شناسهاش بهروزرسانی کنید.
بدنه درخواست
-
- Data
data- نوع
- JSON
- توضیحات
- شیء موردنظر برای بهروزرسانی بهصورت JSON
روشهای جایگزین
برای کلاینتهایی که از درخواست PUT پشتیبانی نمیکنند، میتوانید با همان هدرها و بدنه درخواست از POST یا GET استفاده کنید:
/api/api-key-custom-role/:id/update-item
درخواست بهروزرسانی
PUT/api/api-key-custom-role/:id
Content-Type: application/json ApiKey: YOUR_API_KEY
{
"data": {}
}
پاسخ
{}
/api/api-key-custom-role/:id
حذف با شناسه
این نقطه پایانی به شما امکان میدهد شیء را با شناسهاش حذف کنید.
روشهای جایگزین
برای کلاینتهایی که از درخواست DELETE پشتیبانی نمیکنند، میتوانید با همان هدرها و بدنه درخواست از POST یا GET استفاده کنید:
/api/api-key-custom-role/:id/delete-item
درخواست حذف
DELETE/api/api-key-custom-role/:id
Content-Type: application/json ApiKey: YOUR_API_KEY
پاسخ
{}
دسترسیها
توکن API شما برای ساخت، بهروزرسانی، خواندن یا حذف این منبع به دسترسی نیاز دارد. اگر اجازه ارسال یک درخواست را نداشته باشید، وضعیت 4xx در پاسخ فرستاده میشود.
دسترسیهای خواندن
برای خواندن API Key Custom Role لازم است
-
ProjectOwner- Project Owner
- Owner of this project. Does everything Project Admin does, and also manages billing and payment methods, sets up SCIM, and can delete the project.
-
ProjectAdmin- Project Admin
- Admin of this project. Creates, changes and deletes everything in it, including team members and their permissions, API keys, labels, SSO, rules and custom fields, and reads the audit log. Cannot manage billing, set up SCIM or delete the project.
-
ReadProjectApiKey- Read API Key
- This permission can read api keys of this project.
دسترسیهای ساخت
برای ساخت API Key Custom Role لازم است
-
ProjectOwner- Project Owner
- Owner of this project. Does everything Project Admin does, and also manages billing and payment methods, sets up SCIM, and can delete the project.
-
ProjectAdmin- Project Admin
- Admin of this project. Creates, changes and deletes everything in it, including team members and their permissions, API keys, labels, SSO, rules and custom fields, and reads the audit log. Cannot manage billing, set up SCIM or delete the project.
-
EditProjectApiKeyPermissions- Edit API Key Permissions
- This permission can edit api key permissions of this project.
دسترسیهای بهروزرسانی
برای بهروزرسانی API Key Custom Role لازم است
-
ProjectOwner- Project Owner
- Owner of this project. Does everything Project Admin does, and also manages billing and payment methods, sets up SCIM, and can delete the project.
-
ProjectAdmin- Project Admin
- Admin of this project. Creates, changes and deletes everything in it, including team members and their permissions, API keys, labels, SSO, rules and custom fields, and reads the audit log. Cannot manage billing, set up SCIM or delete the project.
-
EditProjectApiKeyPermissions- Edit API Key Permissions
- This permission can edit api key permissions of this project.
دسترسیهای حذف
برای حذف API Key Custom Role لازم است
-
ProjectOwner- Project Owner
- Owner of this project. Does everything Project Admin does, and also manages billing and payment methods, sets up SCIM, and can delete the project.
-
ProjectAdmin- Project Admin
- Admin of this project. Creates, changes and deletes everything in it, including team members and their permissions, API keys, labels, SSO, rules and custom fields, and reads the audit log. Cannot manage billing, set up SCIM or delete the project.
-
DeleteProjectApiKey- Delete API Key
- This permission can delete api keys of this project.
-
EditProjectApiKeyPermissions- Edit API Key Permissions
- This permission can edit api key permissions of this project.