Find access control groups by name prefix

Retrieve all access control groups with a name starting with the specified prefix

POST /api/accesscontrol/findAccessControlGroupsByNamePrefix

Find access control groups by name prefix

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/accesscontrol/findAccessControlGroupsByNamePrefix \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "groupNamePrefix": "Eng"
}
'

200

{
  "groups": [
    {
      "createdAtMillis": 123,
      "description": "<string>",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "updatedAtMillis": 123,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request to find organization groups by name prefix.

groupNamePrefix · string | null

Name prefix to search for groups

Example:

"Eng"

Response

200 - application/json

OK

Response containing organization groups found by name prefix.

groups · object[] | null

List of organization groups found by name prefix

Show child attributes