Access Cards
Create custom Access Cards granting access to selected Systems and assign it to your Team Members.
Authorizations
Responses
200
OK
application/json
Responseobject
get
GET /api/v1/access-cards HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
[
{
"id": "8e4a413c-7f7b-4925-9b9b-e22c3f65f2a0",
"name": "GoodAccess Access Card",
"description": "Access Card created from GoodAccess Contronl Panel for internal systems",
"members": [
{
"id": "57f25acc-7eb8-494b-bb64-7671b5726e2d",
"created_at": "2024-05-07 10:48:44",
"team_id": "162b441d-6c72-4597-92ea-185af41078cb",
"avatar_url": "router.png",
"name": "GoodAccess User",
"username": "[email protected]",
"is_user_blocked": true,
"is_mfa_active": false
}
],
"systems": [
{
"id": "69f25acc-7eb8-494b-bb64-7671b5726e2d",
"created_at": "2024-08-15 10:48:44",
"name": "GoodAccess System",
"is_valid": true,
"port": "8080",
"host": "goodaccess.com",
"uri": "https://goodaccess.com"
}
]
}
]
Authorizations
Path parameters
accessCardIdstringRequired
ID of access card
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
get
GET /api/v1/access-card/{accessCardId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "8e4a413c-7f7b-4925-9b9b-e22c3f65f2a0",
"name": "GoodAccess Access Card",
"description": "Access Card created from GoodAccess Contronl Panel for internal systems",
"members": [
{
"id": "57f25acc-7eb8-494b-bb64-7671b5726e2d",
"created_at": "2024-05-07 10:48:44",
"team_id": "162b441d-6c72-4597-92ea-185af41078cb",
"avatar_url": "router.png",
"name": "GoodAccess User",
"username": "[email protected]",
"is_user_blocked": true,
"is_mfa_active": false
}
],
"systems": [
{
"id": "69f25acc-7eb8-494b-bb64-7671b5726e2d",
"created_at": "2024-08-15 10:48:44",
"name": "GoodAccess System",
"is_valid": true,
"port": "8080",
"host": "goodaccess.com",
"uri": "https://goodaccess.com"
}
]
}
Authorizations
Body
objectOptionalExample:
{"name":"Example GoodAccess Access Card","description":"Description"}
Responses
200
OK
application/json
Responseobject
409
Conflict
application/json
post
POST /api/v1/access-card HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69
{
"name": "Example GoodAccess Access Card",
"description": "Description"
}
{
"created_id": "4514960a-2b6d-46a2-9c22-c02cc727abb7",
"message": "Access card created successfully"
}
Authorizations
Path parameters
accessCardIdstringRequired
ID of access card
Body
objectOptionalExample:
{"name":"GoodAccess Access Card","description":"Description"}
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
409
Conflict
application/json
put
PUT /api/v1/access-card/{accessCardId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61
{
"name": "GoodAccess Access Card",
"description": "Description"
}
{
"status": 200,
"message": "Access card updated successfully"
}
Authorizations
Path parameters
accessCardIdstringRequired
ID of access card
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
delete
DELETE /api/v1/access-card/{accessCardId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"message": "User with id <member-id> has been removed."
}
Last updated
Was this helpful?