> ## Documentation Index > Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt > Use this file to discover all available pages before exploring further. # List suggested job role permissions > List the permissions the owner of a shared job role has attached to it, as a recommendation for your organisation. A job role's permissions apply only in the organisation that attached them, so a job role shared with your organisation arrives carrying none of its owner's permissions. This endpoint shows what the owner considers the role needs, so you can copy the parts you want into your own organisation as your own grants. Nothing returned here is in force for your organisation until you do. Scopes are not transferable: a scope naming the owner's resources means nothing in your organisation, so copy the permission and set your own scope. Returns an empty list for a job role your own organisation owns, because that organisation's set is the active one and is readable through `/v3/grants`. Requires the role to be shared, an active bridge from the role's owner to the organisation named in the query, membership of that organisation, and permission to create grants in it. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v3/job-roles/{job_role_id}/suggested-permissions openapi: 3.1.0 info: contact: email: support@ctrl-hub.com name: Ctrl Hub url: https://www.ctrl-hub.com description: > Ctrl Hub is the all-in-one platform for high-risk industries like utilities, construction, infrastructure, and renewables. We help teams manage everything from risk assessments and HAVS exposure to vehicle and equipment checks, with a guaranteed minimum of 200% ROI. license: name: MIT License url: https://opensource.org/licenses/MIT summary: An API for managing your compliance and risk posture termsOfService: https://www.ctrl-hub.com/terms-conditions title: Ctrl Hub version: 1.0.0 servers: - description: Production url: https://api.ctrl-hub.com - description: Staging url: https://api.ctrl-hub.dev - description: Development url: https://api.ctrl-hub.run security: [] tags: - description: | Actions are follow-ups assigned to users and teams, produced manually or by domain producers such as the data-capture workflow runner. name: Actions - description: | Audit events are the events that are logged by the system. name: Audit Events - description: | View the platform's health and availability. name: Status - description: > User-owned dashboards composed of cards on a fixed-slot bento layout. Cards come from a per-domain registry; the API stores their config as opaque JSON. name: Dashboards - description: > A record of documents the platform generated and handed over, retained as evidence of what was issued. `subject_type` says what kind of records an export covers, and it is what decides how the request is authorised: there is no export permission of its own, so if you can see the records you can export them. name: Exports - description: > Scheduled delivery of a saved query's results, as a CSV attachment or a summary email. Every run is retained with the file it sent, so what a recipient received stays retrievable. A report runs as the person who created it, under their own access. name: Reports - description: | Manage appointments for work to be carried out with your customers name: Customer Appointments - description: | Manage interactions you have with your customers name: Customer Interactions - description: | Manage accounts for your customers name: Customer Accounts and Contacts - description: | Qualifications are the skills and knowledge that an organisation requires. name: Qualifications - description: | Workflows allow you to automate your processes. name: Workflows - description: | Manage documents name: Documents - description: | Manage documents name: Folders - description: | Manage documents name: Document Reviews - description: | Manage feature configurations for an organisation. name: Feature Configurations - description: | Equipment are the physical assets that an organisation manages. name: Equipment - description: | The central cost register: time-versioned rate codes for material, labour, contractor and miscellaneous spend, used to cost work against the job hierarchy. name: Costs - description: > Locations are places an organisation manages, optionally classified by a location type. name: Locations - description: | Manage your forms and their schemas name: Forms, Schemas and Categories - description: | Create and view form submissions name: Submissions - description: | View the roles available in the system. name: IAM Roles - description: > IAM role groups can be assigned to principals to manage authorisation centrally. name: IAM Role Groups - description: | Manage service accounts which can access the API programmatically. name: Service Accounts - description: | Manage bridges between organisations. name: Bridges - description: | Manage settings for an organisation. name: Settings - description: | Manage teams within an organisation. name: Teams - description: | Manage job roles within an organisation. name: Job Roles - description: | Manage users and accounts. name: Users - description: | Invite and manage invitations to organisations. name: Invitations - description: > IAM grants are the asignment of roles or permissions to principals to manage resource access. name: IAM Grants - description: | View the permissions available in the system. name: IAM Permissions - description: | SSO providers are the identity providers for an organisation. name: SSO Providers - description: | Whoami returns information about the currently authenticated principal. name: Whoami - description: | Manage your images name: Images - description: > AI agent personas that synthesise data into role-specific intelligent briefings. name: Agents - description: | Briefings generated by AI agents, including reasoning traces. name: Briefings - description: > Organisations are the center point for most resources in the platform. Most other endpoints are subresources of an organisation. name: Organisations - description: | Permits managements, integrated with street manager. name: Permits - description: | Projects manage your work and governance. name: Projects - description: > Import templates allow users to save and reuse their CSV importer configuration as named templates. name: Import Templates - description: | Properties are the physical locations. name: Properties - description: | Search across schemes, work orders, and operations. name: Search - description: | Provides the API specification in JSON and YAML formats name: Specifications - description: | Streets are the physical roads. name: Streets - description: | Integration with street manager name: Street Manager - description: | Vehicles are the physical vehicles that an organisation manages. name: Vehicles - description: > Scheme contracts (also known as regions) group schemes allocated from the network to a contractor. name: Scheme Contracts - description: > Scheme shares allow you to share your schemes with other organisations across bridges. name: Scheme Shares - description: | Schemes are large programmes of work name: Schemes - description: | Work orders the component parts of a scheme. name: Work Orders - description: | Operations are the work to be carried out within work orders. name: Operations externalDocs: description: More documentation and resources url: https://docs.ctrl-hub.com paths: /v3/job-roles/{job_role_id}/suggested-permissions: get: tags: - Job Roles description: >- List the permissions the owner of a shared job role has attached to it, as a recommendation for your organisation. A job role's permissions apply only in the organisation that attached them, so a job role shared with your organisation arrives carrying none of its owner's permissions. This endpoint shows what the owner considers the role needs, so you can copy the parts you want into your own organisation as your own grants. Nothing returned here is in force for your organisation until you do. Scopes are not transferable: a scope naming the owner's resources means nothing in your organisation, so copy the permission and set your own scope. Returns an empty list for a job role your own organisation owns, because that organisation's set is the active one and is readable through `/v3/grants`. Requires the role to be shared, an active bridge from the role's owner to the organisation named in the query, membership of that organisation, and permission to create grants in it. operationId: ListSuggestedJobRolePermissions parameters: - $ref: '#/components/parameters/job_role_id' - description: >- The organisation asking for the suggestion. Must be one you are an active member of. Required because job roles are addressed by id alone and a shared role belongs to its owner rather than to you. in: query name: organisation required: true schema: type: string format: uuid responses: '200': $ref: '#/components/responses/ListSuggestedJobRolePermissions' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - OAuth2: [] - Cookie: [] components: parameters: job_role_id: name: job_role_id in: path required: true description: The unique identifier for the job role. schema: type: string format: uuid example: 541bc3a4-1ffd-4be9-a5a0-6a19fbdc3040 responses: ListSuggestedJobRolePermissions: description: >- The permissions the shared job role's owner has attached to it. These are a recommendation only and are never in force for the requesting organisation. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: allOf: - type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/Grant' - $ref: '#/components/schemas/DocumentMeta' - $ref: '#/components/schemas/JSONAPI' BadRequest: description: > There was an error with the request - this could be due to an invalid body, query parameters, or headers that were sent to the API. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 98ca4a78-b66f-4234-9719-aaf832ee6669 status: '400' title: A validation error was encountered source: parameter: include meta: resource: wrong_value Unauthorised: description: Authentication failed headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 05fc9c8d-73b9-4697-9337-57f7a567a48f status: '401' title: You are not authorised to access this resource detail: In order to access this resource, you need the 'admin' role. code: AUTH.001 Forbidden: description: >- The authenticated principal does not hold the grant required for this action headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: errors: - id: 1b3f2c30-2d56-4d3a-9c44-9be9c2cbf2f0 status: '403' title: Forbidden detail: You do not hold the grant required for this action. code: AUTH.002 NotFound: description: The requested resource could not be found headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f status: '404' title: Resource not found detail: The requested resource could not be found or does not exist. code: NOT_FOUND.001 InternalServerError: description: There was a problem handling the request on the server side headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: fe9d9a69-f0a7-4fdc-bb2c-176027f316c5 status: '500' title: Internal Server Error detail: An unexpected error occurred on the server. headers: content-type: description: The content type of the response schema: type: string example: application/vnd.api+json content-length: description: The length of the response body in bytes schema: type: integer format: int32 example: 1234 x-request-id: description: >- An ID that can be provided when reporting bugs to help identify the issue schema: type: string example: 8470f56af4cf25e22be08e72c70dbbdc schemas: Grant: type: object description: A grant required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the grant. type: type: string const: grants attributes: $ref: '#/components/schemas/GrantAttributes' meta: $ref: '#/components/schemas/GrantMeta' relationships: $ref: '#/components/schemas/GrantRelationships' DocumentMeta: type: object description: Document level meta about the resources on the server in list endpoints. required: - meta properties: meta: type: object required: - pagination properties: features: $ref: '#/components/schemas/Features' pagination: $ref: '#/components/schemas/Pagination' JSONAPI: type: object description: JSON API response object required: - jsonapi properties: jsonapi: type: object required: - version properties: version: type: string description: The version of the JSON API specification examples: - '1.0' Error: type: object description: An error response properties: id: description: >- A unique identifier for this particular occurrence of the problem. If you encounter this, please provide us with the error ID and we can investigate it on our side. type: string format: uuid examples: - 05fc9c8d-73b9-4697-9337-57f7a567a48f status: description: >- The status code for the error. This might not match the HTTP status code if there are more that one errors to return with different status codes. type: string examples: - '401' - '500' title: description: A human readable title for the error. type: string examples: - You are not authorised to access this resource detail: description: >- Where there is more detail that we can provide outside of the title, we will provide it here. type: string examples: - In order to access this resource, you need the 'admin' role. code: description: >- A unique code for the error that may help us to diagnose the issue. Not all errors have codes, so this is usually empty. type: string examples: - AUTH.001 source: description: A JSON object containing additional information about the error. type: object properties: pointer: description: >- A JSON Pointer to the value in the request that caused the error. type: string examples: - /data/attributes/email parameter: description: >- A string indicating which query parameter in the request caused the error. type: string examples: - include required: - id - status - title GrantAttributes: type: object description: Attributes of a grant required: - type - subject - scope - reason - expires_at properties: type: type: string enum: - role - permission subject: type: string scope: type: object required: - attributes - patterns properties: attributes: type: array items: type: object properties: name: type: string operation: type: string enum: - '=' - '!=' - '>' - < - '>=' - <= value: type: string patterns: type: array items: type: object properties: name: type: string matcher: type: string enum: - prefix - suffix - contains operation: type: string enum: - '=' - '!=' value: type: string reason: type: string starts_at: type: string format: date-time expires_at: type: string format: date-time GrantMeta: type: object description: Metadata for a grant required: - created_at properties: created_at: type: string format: date-time description: The date and time when the grant was created grantee_type: type: string description: >- The type of grantee this grant is for. The grantee is in the grant relationships. enum: - groups - job-roles - service-accounts - scheme-shares - teams - users GrantRelationships: type: object description: Relationships for a grant required: - organisation - authoriser properties: organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' authoriser: type: object required: - data properties: data: $ref: '#/components/schemas/UserRelationship' principal_job_role: type: object required: - data properties: data: $ref: '#/components/schemas/JobRoleRelationship' principal_role_group: type: object required: - data properties: data: $ref: '#/components/schemas/RoleGroupRelationship' principal_service_account: type: object required: - data properties: data: $ref: '#/components/schemas/ServiceAccountRelationship' principal_scheme_share: type: object required: - data properties: data: $ref: '#/components/schemas/SchemeShareRelationship' principal_team: type: object required: - data properties: data: $ref: '#/components/schemas/TeamRelationship' principal_user: type: object required: - data properties: data: $ref: '#/components/schemas/UserRelationship' Features: type: object description: Represents feature configurations of the API properties: include: type: object properties: options: type: array items: type: string examples: - related.resource Pagination: type: object description: Represents pagination details for API responses required: - counts - current_page - offsets - requested properties: counts: type: object required: - pages - resources properties: pages: type: integer examples: - 1 resources: type: integer examples: - 1 current_page: type: integer examples: - 1 offsets: type: object required: - next - previous properties: next: type: - integer - 'null' examples: - null previous: type: - integer - 'null' examples: - null requested: type: object required: - limit - offset properties: limit: type: integer examples: - 10 offset: type: integer examples: - 0 OrganisationRelationship: type: object description: Represents a relationship to an organisation required: - id - type properties: id: type: string format: uuid description: The unique identifier of the organisation type: type: string const: organisations UserRelationship: type: object description: Represents a relationship to a user required: - id - type properties: id: type: string format: uuid description: The unique identifier of the user type: type: string const: users JobRoleRelationship: type: object description: Represents a relationship to a job role required: - id - type properties: id: type: string format: uuid description: The unique identifier of the job role type: type: string const: job-roles RoleGroupRelationship: type: object description: Represents a relationship to a role group required: - id - type properties: id: type: string format: uuid description: The unique identifier of the role group type: type: string const: role_groups ServiceAccountRelationship: type: object description: Represents a relationship to a service account required: - id - type properties: id: type: string format: uuid description: The unique identifier of the service account type: type: string const: service-accounts SchemeShareRelationship: type: object description: Represents a relationship to a scheme share required: - id - type properties: id: type: string format: uuid description: The unique identifier of the scheme share type: type: string const: scheme-shares TeamRelationship: type: object description: Represents a relationship to a team required: - id - type properties: id: type: string format: uuid description: The unique identifier of the team type: type: string const: teams securitySchemes: Session: description: | Session token for authentication. in: header name: X-Session-Token type: apiKey OAuth2: description: | OAuth2 token for authentication. flows: clientCredentials: scopes: {} tokenUrl: https://auth.ctrl-hub.com/oauth2/token type: oauth2 Cookie: description: | Cookie token for authentication. in: cookie name: ctrl_hub_session type: apiKey ````