LogoLogo
GoodAccess WebsiteRequest Free TrialDownload App
  • Getting Started
    • 1. What is GoodAccess?
    • 2. Architecture Overview
    • 3. Sign up for Free Trial
    • 4. Download App & Connect
  • 🖥️Configuration guides
    • Features
      • Zero Trust Access Control
        • Access Cards
        • Device Posture Check
        • Device Approval
        • Geo Restrictions
      • API Integration
        • API Reference
          • Members
          • Groups
          • Systems
          • Access Cards
          • Relations
          • Gateways
          • Logs
        • Acronis Integration
      • SIEM Integration
      • SSO/SCIM
        • Auth0
        • Cisco Duo
        • Google Workspace
        • JumpCloud
        • Microsoft Entra ID
        • Okta
        • OneLogin
        • Ping Identity
        • Universal (SAML)
      • MFA
      • Passkeys
      • MSI deployment
      • Threat Blocker
      • Custom Domain Blocking
      • DNS Management
      • Split Tunneling
      • Port Forwarding
    • Branch Connector
      • Cisco
      • Cisco Meraki
      • FortiGate
      • MikroTik
      • SonicWall
      • UniFi USG
      • Zyxel Nebula Control Center
      • Other supported routers and firewalls
    • Cloud Connector
      • AWS
      • Google Cloud
      • Microsoft Azure
      • Other Public Cloud providers
    • IP whitelisting
      • APACHE Web Server
      • AWS VPC
      • Azure (Office 365)
      • Google Cloud
      • Google Workspace
      • Magento
      • Microsoft IIS
      • NGINX
        • Domain
        • Subdomain
        • URL
      • OpenCart
      • PHP
      • PHPMyAdmin
      • Pipedrive
      • SalesForce
      • SSH server
      • WordPress
      • Zoho CRM
    • Linux
      • DEB repository
      • RPM repository
      • Manual installation
      • Linux Troubleshooting
  • 🆘FAQ & Troubleshooting
    • FAQ
      • Business
      • Technical
    • Troubleshooting
  • 📓Product Changelog
    • Windows
    • macOS
Powered by GitBook
On this page

Was this helpful?

  1. Configuration guides
  2. Features
  3. API Integration
  4. API Reference

Relations

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

PreviousAccess CardsNextGateways

Last updated 3 months ago

Was this helpful?

🖥️

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
404
Not Found
application/json
409
Conflict
application/json
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
404
Not Found
application/json
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
404
Not Found
application/json
409
Conflict
application/json
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
404
Not Found
application/json
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
404
Not Found
application/json
409
Conflict
application/json
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
404
Not Found
application/json
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
404
Not Found
application/json
409
Conflict
application/json
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
404
Not Found
application/json
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"
}
  • POSTCreates relation between access card and system
  • DELETERemove relation between access card and system
  • POSTCreates relation between access card and team member
  • DELETERemove relation between access card and member
  • POSTCreates relation between group and access card
  • DELETERemoves relation between group and access card
  • POSTCreates relation between group and team member
  • DELETERemoves relation between group and team member