GoodAccess Website Request Free Trial Download App

Access Cards

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

Relations

PreviousSystems NextRelations

Last updated 1 month ago

Was this helpful?

Fetch All access cards

get

/api/v1/access-cards

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://integration.goodaccess.com/api/v1/access-cards' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

[
  {
    "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": "user@goodaccess.com",
        "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

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

Authorizations

Path parameters

accessCardIdstringrequired

ID of access card

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

404 Get Single Access Card

200 Get Single Access Card

{
  "error": "not_found",
  "error_description": "Access card with id \"8e4a413c-7f7b-4925-9b9b-e22c3f65f2a0\" not found"
}

Create Access Card

post

/api/v1/access-card

Authorizations

Body

object

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://integration.goodaccess.com/api/v1/access-card' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Example GoodAccess Access Card","description":"Description"}'

200

409

{
  "created_id": "4514960a-2b6d-46a2-9c22-c02cc727abb7",
  "message": "Access card created successfully"
}

Update Access Card by its ID

put

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

Authorizations

Path parameters

accessCardIdstringrequired

ID of access card

Body

object

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://integration.goodaccess.com/api/v1/access-card/{accessCardId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"GoodAccess Access Card","description":"Description"}'

200

404

409

{
  "status": 200,
  "message": "Access card updated successfully"
}

Remove Access Card by its ID

delete

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

Authorizations

Path parameters

accessCardIdstringrequired

ID of access card

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

{
  "message": "User with id <member-id> has been removed."
}