Access Cards

Create custom Access Cards granting access to selected Systems and assign it to your Team Members.

Fetch All access cards

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

Responseobject

get

/api/v1/access-cards

HTTPcURLJavaScriptPython

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

Fetch Access Card by its ID

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accessCardIdstringRequired

ID of access card

Responses

200

OK

application/json

Responseobject

404

Not Found

application/json

get

/api/v1/access-card/{accessCardId}

HTTPcURLJavaScriptPython

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

Create Access Card

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"name":"Example GoodAccess Access Card","description":"Description"}

Responses

200

OK

application/json

Responseobject

409

Conflict

application/json

post

/api/v1/access-card

HTTPcURLJavaScriptPython

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

Update Access Card by its ID

put

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accessCardIdstringRequired

ID of access card

Body

application/json

objectOptionalExample: {"name":"GoodAccess Access Card","description":"Description"}

Responses

200

OK

application/json

Responseobject

404

Not Found

application/json

409

Conflict

application/json

put

/api/v1/access-card/{accessCardId}

HTTPcURLJavaScriptPython

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

Remove Access Card by its ID

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accessCardIdstringRequired

ID of access card

Responses

200

OK

application/json

Responseobject

404

Not Found

application/json

delete

/api/v1/access-card/{accessCardId}

HTTPcURLJavaScriptPython

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

Relations