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-modellen
Egenskaper
-
- Namn
_id- Typ
- Object ID
- Beskrivning
-
ID of this object
-
Skapa: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLäs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyUppdatera: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissions
-
- Namn
createdAt- Typ
- Date
- Beskrivning
-
Date and Time when the object was created.
-
Skapa: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLäs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyUppdatera: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissions
-
- Namn
updatedAt- Typ
- Date
- Beskrivning
-
Date and Time when the object was updated.
-
Skapa: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLäs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyUppdatera: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissions
-
- Namn
project- Typ
- Project
- Beskrivning
-
Relation to Project Resource in which this object belongs
-
Skapa: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLäs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyUppdatera: Kan inte uppdateras
-
- Namn
projectId- Typ
- Object ID Obligatorisk
- Beskrivning
-
ID of your OneUptime Project in which this object belongs
-
Skapa: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLäs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyUppdatera: Kan inte uppdateras
-
- Namn
apiKey- Typ
- API Key
- Beskrivning
-
The API key given the role.
-
Skapa: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLäs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyUppdatera: Kan inte uppdateras
-
- Namn
apiKeyId- Typ
- Object ID Obligatorisk
- Beskrivning
-
ID of the API key given the role.
-
Skapa: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLäs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyUppdatera: Kan inte uppdateras
-
- Namn
customRole- Typ
- Custom Role
- Beskrivning
-
The custom role given to the API key.
-
Skapa: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLäs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyUppdatera: Kan inte uppdateras
-
- Namn
customRoleId- Typ
- Object ID Obligatorisk
- Beskrivning
-
ID of the custom role given to the API key.
-
Skapa: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLäs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyUppdatera: Kan inte uppdateras
-
- Namn
createdByUser- Typ
- User
- Beskrivning
-
Relation to User who created this object (if this object was created by a User)
-
Skapa: AutogenereradLäs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyUppdatera: Kan inte uppdateras
-
- Namn
createdByUserId- Typ
- Object ID
- Beskrivning
-
User ID who created this object (if this object was created by a User)
-
Skapa: AutogenereradLäs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyUppdatera: Kan inte uppdateras
/api/api-key-custom-role/get-list
Lista
Den här slutpunkten gör att du kan hämta en paginerad lista över alla dina API Key Custom Role. Som standard visas högst tio API Key Custom Role per sida.
Valfria frågeparametrar
-
- Limit
limit- Typ
- number
- Beskrivning
- Antal objekt att hämta. Som standard 10, du kan öka detta antal upp till 100
-
- Skip
skip- Typ
- number
- Beskrivning
- Antal objekt att hoppa över. Detta kan vara användbart vid paginering
Valfri Request Body
-
- Query
query- Typ
- query
- Beskrivning
- Om du vill filtrera på API Key Custom Role. Du kan ange en fråga här. För mer information, se hur du skriver frågor här.
-
- Select
select- Typ
- select
- Beskrivning
- Som standard hämtar du endast ID för objekt, för att hämta fler fält måste du välja dem. För mer information, se hur du använder select här.
-
- Sort
sort- Typ
- sort
- Beskrivning
- Objekt sorteras baserat på skapelsedatum som standard. Du kan ändra sorteringsordningen genom att skicka se hur du använder select här.
Listförfrågan
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
}
}
Svar
{
"count": 10,
"limit": 10,
"skip": 0,
"data": [
{
"_id": "0e32e792-f52c-46ad-914e-0b6508d950c7",
"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": "3566861e-45fc-42a4-b557-ae2393c9b6da",
"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": "498267e7-fff1-4156-8971-3543674cead3",
"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
Hämta objekt med ID
Den här slutpunkten gör att du kan hämta API Key Custom Role med ID.
Obligatoriska frågeparametrar
-
- ID
id- Typ
- text
- Beskrivning
- ID för objektet
Valfri Request Body
-
- Select
select- Typ
- select
- Beskrivning
- Som standard hämtar du endast ID för objekt, för att hämta fler fält måste du välja dem. För mer information, se hur du använder select här.
Hämta objektförfrågan
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
}
}
Svar
{
"_id": "0e32e792-f52c-46ad-914e-0b6508d950c7",
"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
Antal
Den här slutpunkten gör att du kan hämta antalet av alla dina API Key Custom Role.
Valfri Request Body
-
- Query
query- Typ
- query
- Beskrivning
- Om du vill filtrera på API Key Custom Role. Du kan ange en fråga här. För mer information, se hur du skriver frågor här.
Antalsförfrågan
POST/api/api-key-custom-role/count
Content-Type: application/json ApiKey: YOUR_API_KEY
{
"query": {}
}
Svar
{
"count": 107
}
/api/api-key-custom-role
Skapa API Key Custom Role
Den här slutpunkten gör att du kan skapa ett nytt objekt.
Begärandekropp
-
- Data
data- Typ
- JSON
- Beskrivning
- Objekt att skapa som JSON
Skapa förfrågan
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"
}
}
Svar
{
"_id": "0e32e792-f52c-46ad-914e-0b6508d950c7",
"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
Uppdatera med ID
Den här slutpunkten gör att du kan uppdatera ett objekt med dess ID.
Begärandekropp
-
- Data
data- Typ
- JSON
- Beskrivning
- Objekt att uppdatera som JSON
Alternativa metoder
För klienter som inte stöder PUT-förfrågningar kan du använda POST eller GET med samma request headers och body:
/api/api-key-custom-role/:id/update-item
Uppdateringsförfrågan
PUT/api/api-key-custom-role/:id
Content-Type: application/json ApiKey: YOUR_API_KEY
{
"data": {}
}
Svar
{}
/api/api-key-custom-role/:id
Ta bort med ID
Den här slutpunkten gör att du kan ta bort ett objekt med dess ID.
Alternativa metoder
För klienter som inte stöder DELETE-förfrågningar kan du använda POST eller GET med samma request headers och body:
/api/api-key-custom-role/:id/delete-item
Borttagningsförfrågan
DELETE/api/api-key-custom-role/:id
Content-Type: application/json ApiKey: YOUR_API_KEY
Svar
{}
Behörigheter
Din API-token behöver behörigheter för att skapa, uppdatera, läsa eller ta bort denna resurs. Om du inte har behörigheter att göra en förfrågan kommer en 4xx-status att skickas som svar.
Läsbehörigheter
Krävs för att läsa 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.
Skapa-behörigheter
Krävs för att skapa 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.
Uppdateringsbehörigheter
Krävs för att uppdatera 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.
Borttagningsbehörigheter
Krävs för att ta bort 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.