aYOUne
← Configuration API

Credentials

Singular: Credential — Base URL: https://config-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

play_circle Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "sharedWith": {
      "rights": [],
      "teams": []
    },
    "audit": {
      "decryptCount": 0
    },
    "config": {
      "username": "",
      "clientId": "",
      "channelId": "",
      "webhookUrl": "",
      "host": "",
      "scope": "",
      "tokenUrl": "",
      "authUrl": "",
      "callbackUrl": ""
    },
    "secrets": {
      "secret": "***",
      "apiKey": "***",
      "token": "",
      "password": "",
      "refreshToken": ""
    },
    "_id": "6a700c000a810b587c9f410b",
    "name": "twilio-subaccount-5ee06fc2860473001cfb290a",
    "provider": "twilio",
    "type": "api_key",
    "vault": "server",
    "active": true,
    "refreshInterval": 0,
    "tags": [],
    "isDraft": true,
    "createdAt": "2026-08-03T03:33:20.738Z",
    "updatedAt": "2026-08-03T03:33:20.738Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/credentials/6a700c000a810b587c9f410b",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      }
    ],
    "debugId": "6a9ce84203989c22cd56d2df",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CREDENTIAL",
        "href": "https://api.ayoune.app/config/credentials/6a700c000a810b587c9f410b/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CREDENTIAL",
        "href": "https://api.ayoune.app/config/credentials/6a700c000a810b587c9f410b",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.153.0",
      "core": "2026.329.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1094",
      "reset": "1788670916",
      "resetDate": "Sun Sep 06 2026"
    },
    "responseTime": 94.433322,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /credentials List with filters/pagination config.credentials.view
GET /credentials/:id Single record config.credentials.view
POST /credentials Create new record config.credentials.new
PUT /credentials Update record config.credentials.edit
DELETE /credentials/:id Delete record config.credentials.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.config.credentials.find().limit(10).exec();

// Single record
const one = await ay.config.credentials.findById('OBJECT_ID').exec();

// Create
const created = await ay.config.credentials.create({ name: 'Foo' });

See also