Ledger Enterprise
API Documentation V1
API Documentation V1
  • GETTING STARTED
    • Welcome
    • Getting Started
    • Authentication
    • Rate Limits
    • Pagination
  • tutorials
    • Register a new API User
    • First Steps as an API User
    • Generate Reporting API Keys
    • Manage Reporting API Keys
  • REFERENCE
    • API reference
      • Accounts
        • Addresses
        • Balances
          • History
        • Currency
        • History
        • Labels
        • Nft collections
        • Nft portfolio
        • Nfts
        • Sync
        • Tokens
        • Erc20 children accounts
      • Api users
        • Register
      • Currencies
        • Tokens
      • Digests
        • History
      • Entities
        • History
        • Users
      • Groups
        • History
      • Labels
      • Messages
        • History
      • Organization
      • Pledges
      • Requests
        • Approve
        • Challenge
          • Reject
        • Governance status
        • Reject
      • Settlements
      • Transactions
        • Estimate fees
        • Fees
        • Approve
        • History
        • Labels
        • Reject
      • Users
        • History
      • Whitelists
        • History
      • Auth
        • Token
          • Refresh
      • Compliance
        • Address risk
        • Sanctions
      • Notifications
        • Configuration
    • Specification
Powered by GitBook
On this page
  1. REFERENCE
  2. API reference

Api users

PreviousErc20 children accountsNextRegister

Get API user

get

Get API user by name

Authorizations
Path parameters
namestringRequired

The user's name

Example: api_lam_user
Responses
200
API user object
application/json
404
user name does not exist
get
GET /api_users/{name} HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*
{
  "device_id": "1a24480566ce42c2",
  "name": "api_lam_user",
  "role": "OPERATOR",
  "type_": "SOFT_PSD",
  "workspace": "crypstocks"
}
  • GETGet list of API users
  • POSTCreate an API user
  • GETGet API user

Get list of API users

get

Get list of API users

Authorizations
Responses
200
list of API users
application/json
get
GET /api_users HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*
200

list of API users

{
  "api_users": [
    {
      "device_id": "1a24480566ce42c2",
      "name": "api_lam_user",
      "role": "OPERATOR",
      "type_": "SOFT_PSD",
      "workspace": "crypstocks"
    }
  ]
}

Create an API user

post

Create an API user.

Authorizations
Body
namestringRequired

Api user name

Example: api_lam_userPattern: ^\w{1,20}$
Responses
200
API user object
application/json
400
User already exists
application/json
post
POST /api_users HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "name": "api_lam_user"
}
{
  "device_id": "1a24480566ce42c2",
  "name": "api_lam_user",
  "role": "OPERATOR",
  "type_": "SOFT_PSD",
  "workspace": "crypstocks"
}