सामग्री पर जाएँ
साइन इन करें
API संदर्भ
संसाधन

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

  • नाम
    createdAt
    प्रकार
    Date
    विवरण

    Date and Time when the object was created.

  • नाम
    updatedAt
    प्रकार
    Date
    विवरण

    Date and Time when the object was updated.

  • नाम
    project
    प्रकार
    Project
    विवरण

    Relation to Project Resource in which this object belongs

  • नाम
    projectId
    प्रकार
    Object ID आवश्यक
    विवरण

    ID of your OneUptime Project in which this object belongs

  • नाम
    apiKey
    प्रकार
    API Key
    विवरण

    The API key given the role.

  • नाम
    apiKeyId
    प्रकार
    Object ID आवश्यक
    विवरण

    ID of the API key given the role.

  • नाम
    customRole
    प्रकार
    Custom Role
    विवरण

    The custom role given to the API key.

  • नाम
    customRoleId
    प्रकार
    Object ID आवश्यक
    विवरण

    ID of the custom role given to the API key.

  • नाम
    createdByUser
    प्रकार
    User
    विवरण

    Relation to User who created this object (if this object was created by a User)

  • नाम
    createdByUserId
    प्रकार
    Object ID
    विवरण

    User ID who created this object (if this object was created by a User)

GET या POST
/api/api-key-custom-role/get-list

सूची

यह एंडपॉइंट आपको अपने सभी API Key Custom Role की एक पेजिनेटेड सूची प्राप्त करने की अनुमति देता है। डिफ़ॉल्ट रूप से, प्रति पृष्ठ अधिकतम दस API Key Custom Role दिखाए जाते हैं।

वैकल्पिक क्वेरी पैरामीटर

  • Limit
    limit
    प्रकार
    number
    विवरण
    लाने के लिए ऑब्जेक्ट्स की संख्या। डिफ़ॉल्ट रूप से 10, आप इस गणना को 100 तक बढ़ा सकते हैं
  • Skip
    skip
    प्रकार
    number
    विवरण
    छोड़ने के लिए ऑब्जेक्ट्स की संख्या। यह पेजिनेशन में उपयोगी हो सकता है

वैकल्पिक अनुरोध बॉडी

  • Query
    query
    प्रकार
    query
    विवरण
    यदि आप API Key Custom Role पर फ़िल्टर करना चाहते हैं। आप यहाँ एक क्वेरी निर्दिष्ट कर सकते हैं। अधिक जानकारी के लिए, कृपया यहाँ क्वेरी लिखने की जाँच करें।
  • Select
    select
    प्रकार
    select
    विवरण
    डिफ़ॉल्ट रूप से आप केवल ऑब्जेक्ट्स की ID पुनः प्राप्त करेंगे, अधिक फ़ील्ड पुनः प्राप्त करने के लिए आपको उन्हें चुनना होगा। अधिक जानकारी के लिए, कृपया देखें कि यहाँ कैसे चुनें।
  • 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": "ab3e9f81-05ce-414c-875a-ab4fc6fc970b",
            "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": "c4193bcf-85ce-4e3d-8ff0-c6204c5f1937",
            "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": "7b427d6b-9335-417c-bf80-d3f256f2015a",
            "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"
        }
    ]
}
GET या POST
/api/api-key-custom-role/:id/get-item

ID द्वारा आइटम प्राप्त करें

यह एंडपॉइंट आपको ID द्वारा API Key Custom Role पुनः प्राप्त करने की अनुमति देता है।

आवश्यक क्वेरी पैरामीटर

  • ID
    id
    प्रकार
    text
    विवरण
    ऑब्जेक्ट की ID

वैकल्पिक अनुरोध बॉडी

  • Select
    select
    प्रकार
    select
    विवरण
    डिफ़ॉल्ट रूप से आप केवल ऑब्जेक्ट्स की ID पुनः प्राप्त करेंगे, अधिक फ़ील्ड पुनः प्राप्त करने के लिए आपको उन्हें चुनना होगा। अधिक जानकारी के लिए, कृपया देखें कि यहाँ कैसे चुनें।

आइटम प्राप्त करें अनुरोध

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": "ab3e9f81-05ce-414c-875a-ab4fc6fc970b",
    "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"
}
POST
/api/api-key-custom-role/count

गणना

यह एंडपॉइंट आपको अपने सभी API Key Custom Role की गणना पुनः प्राप्त करने की अनुमति देता है।

वैकल्पिक अनुरोध बॉडी

गणना अनुरोध

POST
/api/api-key-custom-role/count
हेडर
Content-Type: application/json
ApiKey: YOUR_API_KEY
बॉडी
{
  "query": {}
}

प्रतिक्रिया

{
    "count": 107
}
POST
/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": "ab3e9f81-05ce-414c-875a-ab4fc6fc970b",
    "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"
}
PUT
/api/api-key-custom-role/:id

ID द्वारा अपडेट करें

यह एंडपॉइंट आपको इसकी ID द्वारा ऑब्जेक्ट अपडेट करने की अनुमति देता है।

अनुरोध बॉडी

  • Data
    data
    प्रकार
    JSON
    विवरण
    JSON के रूप में अपडेट करने के लिए ऑब्जेक्ट

वैकल्पिक विधियाँ

उन क्लाइंट्स के लिए जो PUT अनुरोधों का समर्थन नहीं करते हैं, आप समान अनुरोध हेडर और बॉडी के साथ POST या GET का उपयोग कर सकते हैं:

POST /api/api-key-custom-role/:id/update-item

अपडेट अनुरोध

PUT
/api/api-key-custom-role/:id
हेडर
Content-Type: application/json
ApiKey: YOUR_API_KEY
बॉडी
{
  "data": {}
}

प्रतिक्रिया

{}
DELETE
/api/api-key-custom-role/:id

ID द्वारा हटाएँ

यह एंडपॉइंट आपको इसकी ID द्वारा ऑब्जेक्ट हटाने की अनुमति देता है।

वैकल्पिक विधियाँ

उन क्लाइंट्स के लिए जो DELETE अनुरोधों का समर्थन नहीं करते हैं, आप समान अनुरोध हेडर और बॉडी के साथ POST या GET का उपयोग कर सकते हैं:

POST /api/api-key-custom-role/:id/delete-item

हटाएँ अनुरोध

DELETE
/api/api-key-custom-role/:id
हेडर
Content-Type: application/json
ApiKey: YOUR_API_KEY

प्रतिक्रिया

{}

अनुमतियाँ

इस संसाधन को बनाने, अपडेट करने, पढ़ने या हटाने के लिए आपके API Token को अनुमतियों की आवश्यकता है। यदि आपके पास अनुरोध करने की अनुमति नहीं है तो प्रतिक्रिया के रूप में 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.