> ## Documentation Index > Fetch the complete documentation index at: https://developers.logicgate.ai/llms.txt > Use this file to discover all available pages before exploring further. # Find a role that is synced with the specified UserGroup ## OpenAPI ````yaml GET /api/v1/roles/user-group/{userGroupId} openapi: 3.1.0 info: title: Risk Cloud API description: >- The Risk Cloud API is a collection of RESTful API endpoints that empower you and your team to directly integrate, automate, and build with the Risk Cloud. Risk Cloud API endpoint payloads are JSON based, with some endpoints supporting exports in CSV and XSLX formats for flexible integration. This API documentation showcases our Risk Cloud API v1, containing a variety of endpoints with continued support for enabling integrations with the Risk Cloud. Visit the [LogicGate Risk Cloud Developer Portal](https://www.logicgate.com/developer/) to get started with building your custom integration with quick start guides, usage guides, release notes, and more. Or download the [v1 OpenAPI specification](/legacy-openapi.json). Explore our [Risk Cloud API v2](https://docs.logicgate.com/v2/index.html) endpoints and documentation as well. [Risk Cloud API v2](https://docs.logicgate.com/v2/index.html) is our collection of API-First endpoints that are tailor made for our developer users, offer concise and highly documented details, are supported by a [Postman collection](https://www.postman.com/logicgate-postman/workspace/logicgate-risk-cloud-api/collection/29257227-de8d264b-6eeb-4177-bea6-2da0a8cabffc) and [v2 OpenAPI specification](https://github.com/LogicGateTech/openapi), and contain our latest API endpoint releases. contact: name: developer-relations@logicgate.com email: developer-relations@logicgate.com version: v2026.11.0 servers: - url: https://{subdomain}.logicgate.com description: Your Risk Cloud environment. variables: subdomain: description: Your Risk Cloud environment's subdomain (e.g. `qa`). default: your-instance security: - ApiToken: [] - basic: [] tags: - name: Authentication description: >- Getting Started: How to create an [API Access Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/) to begin integrating with the Risk Cloud API - name: Attachment description: Endpoints for uploading, downloading, and retrieving record attachments. - name: Field description: Endpoints for creating, updating, and querying fields. - name: Principal description: >- Endpoints for the authenticated principal to view and manage their own details. - name: Record Audit description: Endpoints for retrieving record audit history and productivity data. - name: Step description: Endpoints for retrieving steps and the steps a user can access. - name: Table Report description: Endpoints for retrieving and managing table reports. - name: User Group description: Endpoints for managing user groups and their membership. externalDocs: description: Developer Portal url: https://www.logicgate.com/developer/ paths: /api/v1/roles/user-group/{userGroupId}: get: tags: - Role summary: Find a role that is synced with the specified UserGroup. operationId: findBySyncedUserGroup parameters: - name: userGroupId in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Role_FullRoleSummary' components: schemas: Role_FullRoleSummary: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time name: type: string locked: type: boolean superAdmin: type: boolean defaultRoleForNewUsers: type: boolean autoprovisioned: type: boolean externalId: type: string stepPermissionSets: type: array items: $ref: '#/components/schemas/StepPermissionSet_FullRoleSummary' uniqueItems: true moduleEntitlements: type: array items: $ref: '#/components/schemas/ModuleEntitlement_FullRoleSummary' uniqueItems: true userGroup: $ref: '#/components/schemas/UserGroup_FullRoleSummary' users: type: array items: $ref: '#/components/schemas/User_FullRoleSummary' userCount: type: integer format: int32 moduleCount: type: integer format: int32 required: - active - autoprovisioned - created - defaultRoleForNewUsers - externalId - id - locked - moduleEntitlements - name - stepPermissionSets - superAdmin - updated - userCount - userGroup - users StepPermissionSet_FullRoleSummary: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time name: type: string locked: type: boolean defaultStepPermissionSetForNewUsers: type: boolean permissions: type: array items: $ref: '#/components/schemas/StepPermission_FullRoleSummary' users: type: array items: $ref: '#/components/schemas/User_FullRoleSummary' application: $ref: '#/components/schemas/Application_FullRoleSummary' applicationId: type: string userIds: type: array items: type: string required: - active - application - applicationId - created - defaultStepPermissionSetForNewUsers - id - locked - name - permissions - updated - userIds - users ModuleEntitlement_FullRoleSummary: type: object properties: module: $ref: '#/components/schemas/Module_FullRoleSummary' operationType: type: string enum: - READ - EDIT neo4jId: type: string created: type: string format: date-time updated: type: string format: date-time end: $ref: '#/components/schemas/Module_FullRoleSummary' type: type: string enum: - STEP_PERMISSION - APPLICATION - MODULE endId: type: string startId: type: string required: - created - end - updated UserGroup_FullRoleSummary: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time title: type: string required: - active - created - id - title - updated User_FullRoleSummary: allOf: - $ref: '#/components/schemas/CurrentValue_FullRoleSummary' - type: object properties: email: type: string status: type: string first: type: string last: type: string description: Entity for storing all information pertaining to a user. discriminator: propertyName: status oneOf: - description: Circular reference to Active_FullRoleSummary - description: >- And other types: Automated_FullRoleSummary, Disabled_FullRoleSummary, External_FullRoleSummary, Locked_FullRoleSummary, Service_FullRoleSummary properties: status: type: string required: - status StepPermission_FullRoleSummary: type: object properties: neo4jId: type: string created: type: string format: date-time updated: type: string format: date-time end: $ref: '#/components/schemas/Step_FullRoleSummary' operationType: type: string enum: - READ - EDIT permissionSetId: type: string step: $ref: '#/components/schemas/Step_FullRoleSummary' permissionSet: description: Circular reference to StepPermission_FullRoleSummary writeOnly: true type: type: string deprecated: true enum: - STEP_PERMISSION - APPLICATION - MODULE endId: type: string startId: type: string required: - created - end - operationType - permissionSetId - updated Application_FullRoleSummary: type: object description: >- An entity for managing top-level application data. A application represents the highest level of organization for other entities within the application. properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time name: type: string description: Name of the application. createdBy: $ref: '#/components/schemas/User_FullRoleSummary' description: Creator of the application. description: type: string description: Description of the application. maxLength: 2000 minLength: 0 color: type: string description: Icon color of the application. icon: type: string description: Icon type of the application. enum: - >- fa-bookmark, fa-bolt, fa-bullhorn, fa-certificate,fa-check-square-o, fa-cloud, fa-comments, fa-dollar, fa-exclamation-triangle, fa-file-text-o,fa-folder, fa-gift, fa-globe, fa-heartbeat, fa-leaf, fa-legal, fa-life-ring, fa-medkit, fa-money,fa-percent, fa-rocket, fa-signal, fa-university, fa-user-circle type: type: string sourceApplicationId: type: string sourceEnvironment: type: string permissionsEnabled: type: boolean imported: type: boolean copied: type: boolean live: type: boolean currency: type: string enum: - EUR - GBP - USD uxriEnabled: type: boolean description: Whether or not UXRI is enabled on this application. shortCode: type: string description: Short display code for the application in navigation. pattern: ^(?! +$)[a-zA-Z0-9 ]{1,10}$ defaultHomeScreen: $ref: '#/components/schemas/HomeScreen_FullRoleSummary' required: - active - color - copied - created - createdBy - currency - defaultHomeScreen - description - icon - id - imported - live - name - permissionsEnabled - shortCode - sourceApplicationId - sourceEnvironment - type - updated - uxriEnabled Module_FullRoleSummary: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time value: type: string enum: - A_ASSIGN - A_BULK_UPDATE_FIELDS - A_BULK_LINK_RECORDS - A_IMPORT - A_ALL_FIELDS - A_BUILD - A_API_ACCESS - A_MCP_ACCESS - A_DELETE_RECORDS - A_DUPLICATE_RECORDS - C_CONTROL_FRAMEWORKS - C_EVIDENCE_AUTOMATIONS - C_EVIDENCE_SOURCES - C_GAP_ANALYSIS - A_QUANTIFY - R_RECORDS - R_STATUS - R_PRODUCTIVITY - R_TABLE_REPORTS - R_DASHBOARDS - R_SPARK_AI_REPORTING_ASSISTANT - ADMIN_ALL onlyUse: type: boolean tab: type: string name: type: string required: - active - created - id - name - onlyUse - tab - updated - value CurrentValue_FullRoleSummary: type: object description: Entity used to manage record's field data. discriminator: propertyName: discriminator oneOf: - $ref: '#/components/schemas/CurrentCommonValue_FullRoleSummary' - description: >- And other types: CurrentDateValue_FullRoleSummary, CurrentDateRangeValue_FullRoleSummary, CurrentJobValue_FullRoleSummary, CurrentCommonValue_FullRoleSummary, CurrentDateValue_FullRoleSummary, CurrentDateRangeValue_FullRoleSummary, LabelValue_FullRoleSummary, CleanAttachment_FullRoleSummary, DirtyAttachment_FullRoleSummary, PendingAttachment_FullRoleSummary, CurrentGoogleAttachmentValue_FullRoleSummary, CurrentSharepointAttachmentValue_FullRoleSummary, Active_FullRoleSummary, Automated_FullRoleSummary, Disabled_FullRoleSummary, External_FullRoleSummary, Locked_FullRoleSummary, Service_FullRoleSummary, CurrentNumericRangeValue_FullRoleSummary, CurrentJobValue_FullRoleSummary properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time discriminator: type: string idOrTransientId: type: string transientIdOrId: type: string textOrNumericValue: type: string empty: type: boolean required: - active - created - discriminator - id - updated Step_FullRoleSummary: type: object description: An entity to store details about a specific step within a workflow discriminator: propertyName: stepType oneOf: - $ref: '#/components/schemas/Origin_FullRoleSummary' - description: >- And other types: Chain_FullRoleSummary, End_FullRoleSummary, Origin_FullRoleSummary, Chain_FullRoleSummary, End_FullRoleSummary properties: stepType: type: string description: >- Step type. Advisory on writes. The server resolves the persisted step's type from the step id and ignores any client-supplied value. enum: - ORIGIN - CHAIN - END name: type: string description: Step name. description: type: string description: Description of the step. priority: type: integer format: int32 description: >- Determines the step's place in the workflow. Priority is in descending order with 0 being the first step. userGroupOperationType: type: string description: >- Determine how users are able to interact with user groups on the step. By default, new steps will allow FULL_ACCESS user group editing. enum: - FULL_ACCESS - ADD_ONLY - READ_ONLY xpos: type: integer format: int32 description: Vertical position of the step on the process screen. ypos: type: integer format: int32 description: Horizontal position of the step on the process screen. commentsEnabled: type: boolean description: Allows comments to be displayed on a step. documentsEnabled: type: boolean description: Allows documents to be generated on a step. externalUserMfaRequired: type: boolean description: >- Whether or not to require MFA for external users to access this step. uxriEnabled: type: boolean description: Whether or not to enable UXRI on the step. autofillEnabled: type: boolean description: Whether or not to enable autofill on the step. workflow: $ref: '#/components/schemas/Workflow_FullRoleSummary' description: Workflow that the step belongs to. assignableUserType: type: string description: >- Determine what users are able to be assigned to a record. By default, new records will allow APP_USERS as assignees. enum: - APP_AND_EXTERNAL_USERS - APP_USERS - EXTERNAL_USERS id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time end: type: boolean contains: description: Circular reference to Step_FullRoleSummary writeOnly: true origin: type: boolean chain: type: boolean required: - active - assignableUserType - autofillEnabled - commentsEnabled - created - description - documentsEnabled - externalUserMfaRequired - id - name - priority - stepType - updated - userGroupOperationType - uxriEnabled - workflow - xpos - ypos HomeScreen_FullRoleSummary: type: object properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time required: - active - created - id - updated CurrentCommonValue_FullRoleSummary: allOf: - description: Circular reference to CurrentValue_FullRoleSummary required: - description Origin_FullRoleSummary: allOf: - description: Circular reference to Step_FullRoleSummary Workflow_FullRoleSummary: type: object description: >- An entity that contains information about a set of steps within a particular application. discriminator: propertyName: workflowType oneOf: - $ref: '#/components/schemas/ControlWorkflow_FullRoleSummary' - description: 'And other types: JiraWorkflow_FullRoleSummary' properties: id: type: string active: type: boolean created: type: string format: date-time updated: type: string format: date-time application: $ref: '#/components/schemas/Application_FullRoleSummary' description: Application that the workflow belongs to. contains: description: Circular reference to Workflow_FullRoleSummary writeOnly: true canSelect: description: Circular reference to Workflow_FullRoleSummary writeOnly: true workflowType: type: string required: - active - application - created - id - updated - workflowType ControlWorkflow_FullRoleSummary: allOf: - description: Circular reference to Workflow_FullRoleSummary required: - active - created - id - updated securitySchemes: ApiToken: type: http scheme: bearer bearerFormat: API Token basic: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.