Relations

Define relations like Access Cards with Systems or Members, and Groups with Access Cards or Members.

Creates relation between access card and system

post
Authorizations
Path parameters
accessCardIdstringRequired

ID of access card

systemIdstringRequired

ID of system

Body
Responses
200
OK
application/json
Responseobject
post
POST /api/v1/relation/access-card/{accessCardId}/system/{systemId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "message": "Relation created successfully"
}

Remove relation between access card and system

delete
Authorizations
Path parameters
accessCardIdstringRequired

ID of access card

systemIdstringRequired

ID of system

Responses
200
OK
application/json
Responseobject
delete
DELETE /api/v1/relation/access-card/{accessCardId}/system/{systemId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "message": "Relation removed successfully"
}

Creates relation between access card and team member

post
Authorizations
Path parameters
accessCardIdstringRequired

ID of access card

teamMemberIdstringRequired

ID of team member

Body
Responses
200
OK
application/json
Responseobject
post
POST /api/v1/relation/access-card/{accessCardId}/member/{teamMemberId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "message": "Relation created successfully"
}

Remove relation between access card and member

delete
Authorizations
Path parameters
accessCardIdstringRequired

ID of access card

teamMemberIdstringRequired

ID of team member

Responses
200
OK
application/json
Responseobject
delete
DELETE /api/v1/relation/access-card/{accessCardId}/member/{teamMemberId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "message": "Relation removed successfully"
}

Creates relation between group and access card

post
Authorizations
Path parameters
groupIdstringRequired

ID of access card

accessCardIdstringRequired

ID of access card

Body
Responses
200
OK
application/json
Responseobject
post
POST /api/v1/relation/group/{groupId}/access-card/{accessCardId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "message": "Relation created successfully"
}

Removes relation between group and access card

delete
Authorizations
Path parameters
groupIdstringRequired

ID of access card

accessCardIdstringRequired

ID of access card

Responses
200
OK
application/json
Responseobject
delete
DELETE /api/v1/relation/group/{groupId}/access-card/{accessCardId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "message": "Relation removed successfully"
}

Creates relation between group and team member

post
Authorizations
Path parameters
groupIdstringRequired

ID of access card

teamMemberIdstringRequired

ID of team member

Body
Responses
200
OK
application/json
Responseobject
post
POST /api/v1/relation/group/{groupId}/member/{teamMemberId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "message": "Relation created successfully"
}

Removes relation between group and team member

delete
Authorizations
Path parameters
groupIdstringRequired

ID of access card

teamMemberIdstringRequired

ID of team member

Responses
200
OK
application/json
Responseobject
delete
DELETE /api/v1/relation/group/{groupId}/member/{teamMemberId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "message": "Relation removed successfully"
}

Last updated

Was this helpful?