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

/api/v1/relation/access-card/{accessCardId}/system/{systemId}

Authorizations

Path parameters

accessCardIdstringrequired

ID of access card

systemIdstringrequired

ID of system

Body

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://integration.goodaccess.com/api/v1/relation/access-card/{accessCardId}/system/{systemId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

409

200

{
  "message": "Relation created successfully"
}

OK

Remove relation between access card and system

delete

/api/v1/relation/access-card/{accessCardId}/system/{systemId}

Authorizations

Path parameters

accessCardIdstringrequired

ID of access card

systemIdstringrequired

ID of system

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://integration.goodaccess.com/api/v1/relation/access-card/{accessCardId}/system/{systemId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "message": "Relation removed successfully"
}

OK

Creates relation between access card and team member

post

/api/v1/relation/access-card/{accessCardId}/member/{teamMemberId}

Authorizations

Path parameters

accessCardIdstringrequired

ID of access card

teamMemberIdstringrequired

ID of team member

Body

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://integration.goodaccess.com/api/v1/relation/access-card/{accessCardId}/member/{teamMemberId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

409

200

{
  "message": "Relation created successfully"
}

OK

Remove relation between access card and member

delete

/api/v1/relation/access-card/{accessCardId}/member/{teamMemberId}

Authorizations

Path parameters

accessCardIdstringrequired

ID of access card

teamMemberIdstringrequired

ID of team member

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://integration.goodaccess.com/api/v1/relation/access-card/{accessCardId}/member/{teamMemberId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "message": "Relation removed successfully"
}

OK

Creates relation between group and access card

post

/api/v1/relation/group/{groupId}/access-card/{accessCardId}

Authorizations

Path parameters

groupIdstringrequired

ID of access card

accessCardIdstringrequired

ID of access card

Body

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

409

200

{
  "message": "Relation created successfully"
}

OK

Removes relation between group and access card

delete

/api/v1/relation/group/{groupId}/access-card/{accessCardId}

Authorizations

Path parameters

groupIdstringrequired

ID of access card

accessCardIdstringrequired

ID of access card

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

{
  "message": "Relation removed successfully"
}

OK

Creates relation between group and team member

post

/api/v1/relation/group/{groupId}/member/{teamMemberId}

Authorizations

Path parameters

groupIdstringrequired

ID of access card

teamMemberIdstringrequired

ID of team member

Body

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

409

200

{
  "message": "Relation created successfully"
}

OK

Removes relation between group and team member

delete

/api/v1/relation/group/{groupId}/member/{teamMemberId}

Authorizations

Path parameters

groupIdstringrequired

ID of access card

teamMemberIdstringrequired

ID of team member

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

{
  "message": "Relation removed successfully"
}

OK