POST Agents/User/FindCredentialsGroups

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/User/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.

Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps.

Query String Parameters

Parameter Name Type Description
$select string 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. 
POST /api/v1/Agents/User/FindCredentialsGroups?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

Type, SearchString

Property Name Type Description
Type String
SearchString String

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
Name string 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.
DisplayName string The display name of the group to display to the user.
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/User/FindCredentialsGroups
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "Type": "voluptas",
  "SearchString": "quis"
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "Name": "Zemlak LLC",
    "DisplayName": "Considine-Heller",
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.String",
        "FieldLength": 672
      }
    }
  },
  {
    "Name": "Zemlak LLC",
    "DisplayName": "Considine-Heller",
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.String",
        "FieldLength": 672
      }
    }
  }
]