POST api2/accessgroups.json

Create a access group

Request Information

URI Parameters

None.

Body Parameters

api_root
NameDescriptionTypeAdditional information
accessgroup

CustomerGroups

None.

Request Format

{
  "accessgroup": {
    "name": "sample string 1",
    "valid": 1,
    "company_id": 1,
    "license_id": 1,
    "theme_settings_id": 1,
    "auto_update": true,
    "send_mail": true,
    "sso_platform_id": 1,
    "sso_admin_group_id": "sample string 2",
    "sso_member_group_id": "sample string 3",
    "customers": [
      {
        "id": 1,
        "organisation": "sample string 2",
        "email": "sample string 3",
        "expire_at": "2024-04-24T20:51:45.6560744+02:00",
        "group_id": 1,
        "valid": true,
        "created_at": "2024-04-24T20:51:45.6560744+02:00",
        "confirmed": true,
        "disabled": true,
        "invited": true,
        "custom_data_1": "sample string 4",
        "authentication": 64,
        "allowed_concurrent_users": 1,
        "monthly_cost": 1
      },
      {
        "id": 1,
        "organisation": "sample string 2",
        "email": "sample string 3",
        "expire_at": "2024-04-24T20:51:45.6560744+02:00",
        "group_id": 1,
        "valid": true,
        "created_at": "2024-04-24T20:51:45.6560744+02:00",
        "confirmed": true,
        "disabled": true,
        "invited": true,
        "custom_data_1": "sample string 4",
        "authentication": 64,
        "allowed_concurrent_users": 1,
        "monthly_cost": 1
      }
    ],
    "user_count": 2,
    "project_count": 0,
    "domains": [
      "samplestring1",
      "samplestring2"
    ],
    "invite_type": "InviteOnly"
  }
}

Response Information

Resource Description

created access group

api_root
NameDescriptionTypeAdditional information
accessgroup

CustomerGroups

None.

Response Format

{
  "accessgroup": {
    "created_at": "2024-04-24T20:51:45.6716989+02:00",
    "name": "sample string 1",
    "valid": 1,
    "company_id": 1,
    "license_id": 1,
    "theme_settings_id": 1,
    "auto_update": true,
    "send_mail": true,
    "sso_platform_id": 1,
    "sso_admin_group_id": "sample string 2",
    "sso_member_group_id": "sample string 3",
    "id": 4,
    "customers": [
      {
        "id": 1,
        "organisation": "sample string 2",
        "email": "sample string 3",
        "expire_at": "2024-04-24T20:51:45.9216787+02:00",
        "group_id": 1,
        "valid": true,
        "created_at": "2024-04-24T20:51:45.9216787+02:00",
        "confirmed": true,
        "disabled": true,
        "invited": true,
        "custom_data_1": "sample string 4",
        "authentication": 64,
        "allowed_concurrent_users": 1,
        "monthly_cost": 1
      },
      {
        "id": 1,
        "organisation": "sample string 2",
        "email": "sample string 3",
        "expire_at": "2024-04-24T20:51:45.9216787+02:00",
        "group_id": 1,
        "valid": true,
        "created_at": "2024-04-24T20:51:45.9216787+02:00",
        "confirmed": true,
        "disabled": true,
        "invited": true,
        "custom_data_1": "sample string 4",
        "authentication": 64,
        "allowed_concurrent_users": 1,
        "monthly_cost": 1
      }
    ],
    "user_count": 2,
    "project_count": 0,
    "domains": [
      "samplestring1",
      "samplestring2"
    ],
    "invite_type": "InviteOnly"
  }
}