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
Egenskaber
-
- Navn
_id- Type
- Object ID
- Beskrivelse
-
ID of this object
-
Opret: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLæs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyOpdater: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissions
-
- Navn
createdAt- Type
- Date
- Beskrivelse
-
Date and Time when the object was created.
-
Opret: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLæs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyOpdater: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissions
-
- Navn
updatedAt- Type
- Date
- Beskrivelse
-
Date and Time when the object was updated.
-
Opret: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLæs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyOpdater: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissions
-
- Navn
project- Type
- Project
- Beskrivelse
-
Relation to Project Resource in which this object belongs
-
Opret: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLæs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyOpdater: Kan ikke opdateres
-
- Navn
projectId- Type
- Object ID Påkrævet
- Beskrivelse
-
ID of your OneUptime Project in which this object belongs
-
Opret: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLæs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyOpdater: Kan ikke opdateres
-
- Navn
apiKey- Type
- API Key
- Beskrivelse
-
The API key given the role.
-
Opret: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLæs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyOpdater: Kan ikke opdateres
-
- Navn
apiKeyId- Type
- Object ID Påkrævet
- Beskrivelse
-
ID of the API key given the role.
-
Opret: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLæs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyOpdater: Kan ikke opdateres
-
- Navn
customRole- Type
- Custom Role
- Beskrivelse
-
The custom role given to the API key.
-
Opret: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLæs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyOpdater: Kan ikke opdateres
-
- Navn
customRoleId- Type
- Object ID Påkrævet
- Beskrivelse
-
ID of the custom role given to the API key.
-
Opret: ProjectOwner eller ProjectAdmin eller EditProjectApiKeyPermissionsLæs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyOpdater: Kan ikke opdateres
-
- Navn
createdByUser- Type
- User
- Beskrivelse
-
Relation to User who created this object (if this object was created by a User)
-
Opret: AutogenereretLæs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyOpdater: Kan ikke opdateres
-
- Navn
createdByUserId- Type
- Object ID
- Beskrivelse
-
User ID who created this object (if this object was created by a User)
-
Opret: AutogenereretLæs: ProjectOwner eller ProjectAdmin eller ReadProjectApiKeyOpdater: Kan ikke opdateres
/api/api-key-custom-role/get-list
Liste
Dette endpoint giver dig mulighed for at hente en pagineret liste over alle dine API Key Custom Role. Som standard vises maksimalt ti API Key Custom Role pr. side.
Valgfrie forespørgselsparametre
-
- Limit
limit- Type
- number
- Beskrivelse
- Antal objekter der skal hentes. Som standard 10, du kan øge dette antal op til 100
-
- Skip
skip- Type
- number
- Beskrivelse
- Antal objekter der skal springes over. Dette kan være nyttigt ved paginering
Valgfri anmodningsbrødtekst
-
- Query
query- Type
- query
- Beskrivelse
- Hvis du gerne vil filtrere på API Key Custom Role. Du kan angive en forespørgsel her. For mere information, se venligst, hvordan du skriver forespørgsler her.
-
- Select
select- Type
- select
- Beskrivelse
- Som standard henter du kun ID'et på objekter. For at hente flere felter skal du vælge dem. For mere information, se venligst, hvordan du vælger her.
-
- Sort
sort- Type
- sort
- Beskrivelse
- Objekter sorteres som standard efter oprettelsesdato. Du kan ændre sorteringsrækkefølgen ved at sende se venligst, hvordan du vælger her.
Listeanmodning
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": "ced80826-5de2-4f44-b4e4-188b234ac1db",
"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": "7f5ed13a-97ef-443e-b4d4-fe61957758b8",
"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": "4bac038a-547c-4482-9317-406cdf232191",
"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
Hent element efter ID
Dette endpoint giver dig mulighed for at hente API Key Custom Role efter ID.
Påkrævede forespørgselsparametre
-
- ID
id- Type
- text
- Beskrivelse
- Objektets ID
Valgfri anmodningsbrødtekst
-
- Select
select- Type
- select
- Beskrivelse
- Som standard henter du kun ID'et på objekter. For at hente flere felter skal du vælge dem. For mere information, se venligst, hvordan du vælger her.
Get Item-anmodning
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": "ced80826-5de2-4f44-b4e4-188b234ac1db",
"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
Dette endpoint giver dig mulighed for at hente antallet af alle dine API Key Custom Role.
Valgfri anmodningsbrødtekst
-
- Query
query- Type
- query
- Beskrivelse
- Hvis du gerne vil filtrere på API Key Custom Role. Du kan angive en forespørgsel her. For mere information, se venligst, hvordan du skriver forespørgsler her.
Antalsanmodning
POST/api/api-key-custom-role/count
Content-Type: application/json ApiKey: YOUR_API_KEY
{
"query": {}
}
Svar
{
"count": 107
}
/api/api-key-custom-role
Opret API Key Custom Role
Dette endpoint giver dig mulighed for at oprette et nyt objekt.
Anmodningsbrødtekst
-
- Data
data- Type
- JSON
- Beskrivelse
- Objekt der skal oprettes som JSON
Opret-anmodning
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": "ced80826-5de2-4f44-b4e4-188b234ac1db",
"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
Opdater efter ID
Dette endpoint giver dig mulighed for at opdatere objektet efter dets ID.
Anmodningsbrødtekst
-
- Data
data- Type
- JSON
- Beskrivelse
- Objekt der skal opdateres som JSON
Alternative metoder
For klienter, der ikke understøtter PUT-anmodninger, kan du bruge POST eller GET med de samme anmodnings-headers og brødtekst:
/api/api-key-custom-role/:id/update-item
Opdater-anmodning
PUT/api/api-key-custom-role/:id
Content-Type: application/json ApiKey: YOUR_API_KEY
{
"data": {}
}
Svar
{}
/api/api-key-custom-role/:id
Slet efter ID
Dette endpoint giver dig mulighed for at slette objektet efter dets ID.
Alternative metoder
For klienter, der ikke understøtter DELETE-anmodninger, kan du bruge POST eller GET med de samme anmodnings-headers og brødtekst:
/api/api-key-custom-role/:id/delete-item
Slet-anmodning
DELETE/api/api-key-custom-role/:id
Content-Type: application/json ApiKey: YOUR_API_KEY
Svar
{}
Tilladelser
Dit API-token skal have tilladelser til at oprette, opdatere, læse eller slette denne ressource. Hvis du ikke har tilladelser til at foretage en anmodning, sendes der en 4xx-status som svar.
Læsetilladelser
Påkrævet for at læse 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.
Opret-tilladelser
Påkrævet for at oprette 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.
Opdater-tilladelser
Påkrævet for at opdatere 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.
Slet-tilladelser
Påkrævet for at slette 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.