GoodAccess Website Request Free Trial Download App

Groups

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

Relations

PreviousMembers NextSystems

Last updated 1 month ago

Was this helpful?

Fetch All Groups

get

/api/v1/groups

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://integration.goodaccess.com/api/v1/groups' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

[
  {
    "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

/api/v1/group/{groupId}

Authorizations

Path parameters

groupIdstringrequired

ID of tag

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://integration.goodaccess.com/api/v1/group/{groupId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "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

/api/v1/group

Authorizations

Body

object

Example:

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://integration.goodaccess.com/api/v1/group' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"GoodAccess group","forced_always_on_included":true,"forced_always_on_excluded":true,"geo_restriction_included":false}'

200

409

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

Update Group by its ID

put

/api/v1/group/{groupId}

Authorizations

Path parameters

groupIdstringrequired

ID of tag

Body

object

Example:

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://integration.goodaccess.com/api/v1/group/{groupId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"GoodAccess group","forced_always_on_included":true,"forced_always_on_excluded":true,"geo_restriction_included":false}'

200

404

409

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

Remove Group by its ID

delete

/api/v1/group/{groupId}

Authorizations

Path parameters

groupIdstringrequired

ID of tag

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://integration.goodaccess.com/api/v1/group/{groupId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

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