For Developers

Service Accounts Overview

A Service Account is a non-human machine identity created for automated CI/CD pipelines, background scripts, or backend services that need to interact with the Edlink Meta API.

Properties

A service account is a team membership whose user type is service, returned with that user and its tokens.

PropertyTypeDescription
idUUIDMembership id.
created_dateDateWhen the membership was created.
updated_dateDateWhen the membership was last updated.
stateStringMembership state.
team_idUUIDTeam that owns the membership.
userObjectService user. user.first_name is the display name from create.
tokensArrayTokens for the user. Each token has id, value, and state. value is the secret.

JSON Example

{
    "id": "8b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "created_date": "2024-05-10T14:00:00.000Z",
    "state": "active",
    "team_id": "6a9e99a8-e165-4d0d-9b7d-6062a4be682d",
    "user": {
        "first_name": "GitHub Actions Deployer",
        "type": "service"
    },
    "tokens": [
        {
            "id": "3b7d4bad-9bdd-2b0d-7b3d-cb6d9b1deb4d",
            "value": "a1b2c3d4e5f6",
            "state": "active"
        }
    ]
}