> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Find Credentials Groups > Get user groups holding users filtered by the searchString. This method is only relevant if the CredentialType control is of type link. There will allways be at least one groups even if the underlying provider does not support groups. NsApiSlow threshold: 1000 ms. ## Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps. ## OpenAPI ````yaml /openapi/agent/openapi-v3-UserAgent.json post /api/v1/Agents/User/FindCredentialsGroups openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - UserAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/User/FindCredentialsGroups: post: tags: - User_Agent summary: Find Credentials Groups description: "Get user groups holding users filtered by the searchString.\n\nThis method is only relevant if the CredentialType control is of type link. There will allways be at least one groups even if the underlying provider does not support groups.\r\nNsApiSlow threshold: 1000 ms.\r\n## Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps." operationId: v1UserAgent_FindCredentialsGroups parameters: - name: $select in: query description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.FindCredentialsGroupsRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.FindCredentialsGroupsRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.FindCredentialsGroupsRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.FindCredentialsGroupsRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.FindCredentialsGroupsRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.FindCredentialsGroupsRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.FindCredentialsGroupsRequest description: Type, SearchString required: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.CredentialsGroup text/json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.CredentialsGroup application/xml: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.CredentialsGroup text/xml: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.CredentialsGroup application/json-patch+json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.CredentialsGroup application/merge-patch+json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.CredentialsGroup security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.UserCarriers.FindCredentialsGroupsRequest: description: >- FindCredentialsGroups: Get user groups holding users filtered by the searchString. This method is only relevant if the CredentialType control is of type link. There will allways be at least one groups even if the underlying provider does not support groups. type: object properties: Type: type: string SearchString: type: string SuperOffice.CRM.Services.CredentialsGroup: description: "When the CredentialType's control is of type link, the user is selected from a source like active directory. This will then be the organisational unit (e.g. user security group) in active directory. Only one group is listed if the system does not support groups.\r\n\r\nCarrier object for CredentialsGroup.\r\nServices for the CredentialsGroup Carrier is available from the User Agent." type: object properties: Name: description: >- This is the full name of the group as needed to discover the users within the group. this value should not be displayed to the end user. type: string DisplayName: description: The display name of the group to display to the user. type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [SuperOffice.WebApi.Data.User FindCredentialsGroupsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.User_FindCredentialsGroupsRequest.md) - [NSUserAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSUserAgent.md) - [SuperOffice.WebApi.Agents.IUserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IUserAgent.md) - [SuperOffice.WebApi.Agents.UserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.UserAgent.md) - [Find Credential Users](/en/api/reference/restful/agent/user_agent/find-credential-users.md) - [NSCredentialsGroup](/en/automation/crmscript/reference/CRMScript.NetServer.NSCredentialsGroup.md)