Groups
This endpoint allows you to perform actions on a specific Group of your Team.
Authorizations
Responses
200
OK
application/json
Responseobject
get
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"
}
]
Authorizations
Path parameters
groupIdstringRequired
ID of tag
Responses
200
OK
application/json
Responseobject
get
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"
}
Authorizations
Body
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
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"
}
Authorizations
Path parameters
groupIdstringRequired
ID of tag
Body
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
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"
}
Authorizations
Path parameters
groupIdstringRequired
ID of tag
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
delete
DELETE /api/v1/group/{groupId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": 200,
"message": "Group removed successfully"
}
Last updated
Was this helpful?