--- title: "Create Custom Role Permission" method: POST path: "/custom-role-permission" tags: ["Custom Role Permission"] --- # Create Custom Role Permission `POST /custom-role-permission` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/custom-role-permission` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to create a new Custom Role Permission ## Request body - object - `data` CustomRolePermissionCreateSchema, required: Create schema for CustomRolePermission model. Create - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Edit Team Permissions], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [No access - you don't have permission for this operation] - `customRoleId` string, uuid, required: ID of the custom role this permission is part of. Permissions - Create: [Project Owner, Project Admin, Edit Team Permissions], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [No access - you don't have permission for this operation] - `permission` object: A built-in role, such as IncidentMember, or a single permission, such as ReadProjectIncident. You can find the list of permissions in the Permission Reference. ProjectOwner cannot be part of a custom role. Permissions - Create: [Project Owner, Project Admin, Edit Team Permissions], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [Project Owner, Project Admin, Edit Team Permissions] - `labels` object[]: With the scope Labels: the labels this permission is limited to. A resource carrying at least one of them is reached. Permissions - Create: [Project Owner, Project Admin, Edit Team Permissions], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [Project Owner, Project Admin, Edit Team Permissions] - `id` string - `scope` 'All' | 'Owned' | 'Labels': Which resources this permission reaches. One of: All (every resource in the project), Owned (resources the team given the role, or one of its members, owns), Labels (resources carrying one of the labels). Defaults to All. Permissions - Create: [Project Owner, Project Admin, Edit Team Permissions], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [Project Owner, Project Admin, Edit Team Permissions] ## Response `201` Created successfully - object - `data` CustomRolePermissionReadSchema: Read schema for CustomRolePermission model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Edit Team Permissions], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [Project Owner, Project Admin, Edit Team Permissions] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Edit Team Permissions], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [Project Owner, Project Admin, Edit Team Permissions] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Edit Team Permissions], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [Project Owner, Project Admin, Edit Team Permissions] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Edit Team Permissions], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [Project Owner, Project Admin, Edit Team Permissions] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Edit Team Permissions], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [No access - you don't have permission for this operation] - `customRoleId` string, uuid, required: ID of the custom role this permission is part of. Permissions - Create: [Project Owner, Project Admin, Edit Team Permissions], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [No access - you don't have permission for this operation] - `permission` object: A built-in role, such as IncidentMember, or a single permission, such as ReadProjectIncident. You can find the list of permissions in the Permission Reference. ProjectOwner cannot be part of a custom role. Permissions - Create: [Project Owner, Project Admin, Edit Team Permissions], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [Project Owner, Project Admin, Edit Team Permissions] - `labels` object[]: With the scope Labels: the labels this permission is limited to. A resource carrying at least one of them is reached. Permissions - Create: [Project Owner, Project Admin, Edit Team Permissions], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [Project Owner, Project Admin, Edit Team Permissions] - `id` string - `scope` 'All' | 'Owned' | 'Labels': Which resources this permission reaches. One of: All (every resource in the project), Owned (resources the team given the role, or one of its members, owns), Labels (resources carrying one of the labels). Defaults to All. Permissions - Create: [Project Owner, Project Admin, Edit Team Permissions], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [Project Owner, Project Admin, Edit Team Permissions] - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Teams, Edit Team Permissions], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)