Groups

This endpoint allows you to perform actions on a specific Group of your Team.

Fetch All Groups

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

Responseobject

get

/api/v1/groups

HTTPcURLJavaScriptPython

GET /api/v1/groups HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "name": "GoodAccess group",
    "forced_always_on_included": true,
    "forced_always_on_excluded": true,
    "geo_restriction_included": false,
    "id": "162b441d-6c72-4597-92ea-185af41078cb"
  }
]

Fetch Group by its ID

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

ID of tag

Responses

200

OK

application/json

Responseobject

get

/api/v1/group/{groupId}

HTTPcURLJavaScriptPython

GET /api/v1/group/{groupId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "name": "GoodAccess group",
  "forced_always_on_included": true,
  "forced_always_on_excluded": true,
  "geo_restriction_included": false,
  "id": "162b441d-6c72-4597-92ea-185af41078cb"
}

Create Group

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"name":"GoodAccess group","forced_always_on_included":true,"forced_always_on_excluded":true,"geo_restriction_included":false}

Responses

200

OK

application/json

Responseobject

409

Conflict

application/json

post

/api/v1/group

HTTPcURLJavaScriptPython

POST /api/v1/group HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "name": "GoodAccess group",
  "forced_always_on_included": true,
  "forced_always_on_excluded": true,
  "geo_restriction_included": false
}

{
  "created_id": "4514960a-2b6d-46a2-9c22-c02cc727abb7",
  "message": "Group created successfully"
}

Update Group by its ID

put

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

ID of tag

Body

application/json

objectOptionalExample: {"name":"GoodAccess group","forced_always_on_included":true,"forced_always_on_excluded":true,"geo_restriction_included":false}

Responses

200

OK

application/json

Responseobject

404

Not Found

application/json

409

Conflict

application/json

put

/api/v1/group/{groupId}

HTTPcURLJavaScriptPython

PUT /api/v1/group/{groupId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "name": "GoodAccess group",
  "forced_always_on_included": true,
  "forced_always_on_excluded": true,
  "geo_restriction_included": false
}

{
  "status": 200,
  "message": "Group updated successfully"
}

Remove Group by its ID

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

ID of tag

Responses

200

OK

application/json

Responseobject

404

Not Found

application/json

delete

/api/v1/group/{groupId}

HTTPcURLJavaScriptPython

DELETE /api/v1/group/{groupId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": 200,
  "message": "Group removed successfully"
}

Relations