Access Group Request

This request is used to create/update an access group by specifying its name, description, and inclusion criteria.

Fields

• name (string, required) The name of the access group.

• description (string, required) A brief description of the access group.

• criteria (object, required) Defines the conditions under which entities are included in the access group.

  • The criteria object must contain exactly one include object.

  • The include object contains multiple properties, where each property represents an active job property with category set to the organization.

  Each job property is referenced by its ID and includes the following attributes:

  • all (boolean)
    

    true → Includes all values.
    

    false → Includes only specified values.
    

  • values (array) A list of specific values to include (if all is set to false) or exclude (if all is set to true)

Usage Examples

• Match all countries → all: true and an empty values array.

• Match specific countries → all: false and a list of country codes in values.

• Match all countries except certain ones → all: true with values specifying the excluded countries.

  
  

To obtain a list of available **job properties** under the **`organization`** category, use the **[Get a List of Available Job Properties API](https://developers.smartrecruiters.com/reference/configurationjob-propertiesall-1)**. The **job property ID** should be used as the key in the `include` object.