Find access control group by exact name

Retrieve the access control group with the specified name

POST /api/accesscontrol/findAccessControlGroupByExactName

Find access control group by exact name

cURL

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

200

{
  "group": {
    "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 exact name.

groupName · string | null

Case insensitive name of the group to find, if it exists

Example:

"Engineering Team"

Response

200 - application/json

OK

Response containing organization group found by exact name.

group · object

Guest management host group

Show child attributes