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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accessCardIdstringRequired

ID of access card

systemIdstringRequired

ID of system

Body

Responses

200

application/json

Responseobject

404

Not Found

application/json

409

Conflict

application/json

post

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

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accessCardIdstringRequired

ID of access card

systemIdstringRequired

ID of system

Responses

200

application/json

Responseobject

404

Not Found

application/json

delete

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

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accessCardIdstringRequired

ID of access card

teamMemberIdstringRequired

ID of team member

Body

Responses

200

application/json

Responseobject

404

Not Found

application/json

409

Conflict

application/json

post

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

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accessCardIdstringRequired

ID of access card

teamMemberIdstringRequired

ID of team member

Responses

200

application/json

Responseobject

404

Not Found

application/json

delete

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

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

ID of access card

accessCardIdstringRequired

ID of access card

Body

Responses

200

application/json

Responseobject

404

Not Found

application/json

409

Conflict

application/json

post

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

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

ID of access card

accessCardIdstringRequired

ID of access card

Responses

200

application/json

Responseobject

404

Not Found

application/json

delete

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

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

ID of access card

teamMemberIdstringRequired

ID of team member

Body

Responses

200

application/json

Responseobject

404

Not Found

application/json

409

Conflict

application/json

post

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

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

ID of access card

teamMemberIdstringRequired

ID of team member

Responses

200

application/json

Responseobject

404

Not Found

application/json

delete

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

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

Creates relation between system group and access card

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

systemGroupIdstringRequired

ID of system group

accessCardIdstringRequired

ID of access card

Body

Responses

200

application/json

Responseobject

404

Not Found

application/json

409

Conflict

application/json

post

/api/v1/relation/system-group/{systemGroupId}/access-card/{accessCardId}

POST /api/v1/relation/system-group/{systemGroupId}/access-card/{accessCardId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Relation created successfully"
}

Removes relation between system group and access card

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

systemGroupIdstringRequired

ID of system group

accessCardIdstringRequired

ID of access card

Responses

200

application/json

Responseobject

404

Not Found

application/json

delete

/api/v1/relation/system-group/{systemGroupId}/access-card/{accessCardId}

DELETE /api/v1/relation/system-group/{systemGroupId}/access-card/{accessCardId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Relation removed successfully"
}

Creates relation between system group and system

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

systemGroupIdstringRequired

ID of system group

systemIdstringRequired

ID of system

Body

Responses

200

application/json

Responseobject

404

Not Found

application/json

409

Conflict

application/json

post

/api/v1/relation/system-group/{systemGroupId}/system/{systemId}

POST /api/v1/relation/system-group/{systemGroupId}/system/{systemId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Relation created successfully"
}

Removes relation between system group and system

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

systemGroupIdstringRequired

ID of system group

systemIdstringRequired

ID of system

Responses

200

application/json

Responseobject

404

Not Found

application/json

delete

/api/v1/relation/system-group/{systemGroupId}/system/{systemId}

DELETE /api/v1/relation/system-group/{systemGroupId}/system/{systemId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Relation removed successfully"
}

PreviousAccess Cards NextGateways

Last updated 5 months ago

Was this helpful?