LearnCard Documentation
GithubStatusSupportLaunch App
  • ๐Ÿš€Introduction
    • What is LearnCard?
    • Use Cases & Possibilities
    • Ecosystem Architecture
  • โšกQuick Start
    • Setup & Prerequisites
    • Your First Integration
  • ๐Ÿ“šTutorials
    • Create a Credential
    • Create a Boost
    • Create a ConsentFlow
    • Create a Connected Website
    • Send xAPI Statements
    • Listen to Webhooks
  • โœ…How-To Guides
    • Verify My Issuer
    • Connect Systems
      • Connect a Website
      • Connect a Game
    • Implement Flows
      • Claim Data after Guardian Consent
      • Connect via CHAPI
        • โญCHAPI Wallet Setup Guide
        • โ†”๏ธTranslating to CHAPI documentation
        • ๐Ÿ–ฅ๏ธDemo Application
        • ๐Ÿ”ฐUsing LearnCard to Interact with a CHAPI Wallet
        • ๐Ÿ“Cheat Sheets
          • Issuers
          • Wallets
    • Deploy Infrastructure
      • Remote Key Management
      • Generate API Tokens
      • Signing Authority
      • Connect to Independent Network
      • Build a Plugin
  • ๐Ÿ› ๏ธSDKs & API Reference
    • LearnCard Wallet SDK
      • Authentication
      • Usage Examples
      • SDK Reference
      • Plugin API Reference
      • Integration Strategies
      • Deployment
      • Troubleshooting
      • Changelog
    • LearnCloud Network API
      • Authentication
      • Usage Examples
      • Architecture
      • Notifications & Webhooks
      • Profiles
      • Profile Managers
      • Credentials
      • Boosts
      • Presentations
      • Storage
      • Contracts
      • DID Metadata
      • Claim Hooks
      • Auth Grants
      • Utilities
      • Models
      • OpenAPI
    • LearnCloud Storage API
      • Authentication
      • Usage Examples
      • Architecture
      • Storage
      • Index
      • User
      • Custom Storage
      • Utilities
      • Models
      • xAPI Reference
    • Plugins
      • Crypto
      • DIDKit
      • DID Key
      • Dynamic Loader
      • VC
        • Expiration Sub-Plugin
      • VC-Templates
      • VC-API
      • Ceramic
      • IDX
      • VPQR
      • Ethereum
      • CHAPI
      • LearnCard Network
      • LearnCloud
      • LearnCard
      • Simple Signing
      • Claimable Boosts
    • LearnCard CLI
  • ๐Ÿง Core Concepts
    • Identities & Keys
      • Decentralized Identifiers (DIDs)
      • Seed Phrases
      • Network Profiles
      • Signing Authorities
      • Trust Registries
    • Credentials & Data
      • Verifiable Credentials (VCs)
      • Credential Lifecycle
      • Schemas, Types, & Categories
      • Building Verifiable Credentials
      • Boost Credentials
      • Getting Started with Boosts
      • Credential URIs
      • xAPI Data
      • General Best Practices & Troubleshooting
    • Consent & Permissions
      • ConsentFlow Overview
      • Consent Contracts
      • User Consent & Terms
      • Consent Transactions
      • Auto-Boosts
      • Writing Consented Data
      • Accessing Consented Data
      • GameFlow Overview
    • Network & Interactions
      • Network Vision & Principles
      • Key Network Procedures
      • Core Interaction Workflows
    • Architecture & Principles
      • Control Planes
      • Plugin System
      • Auth Grants and API Tokens
  • ๐Ÿ”—Development
    • Contributing
Powered by GitBook
On this page

Was this helpful?

  1. SDKs & API Reference
  2. LearnCloud Network API

Auth Grants

PreviousClaim HooksNextUtilities

Was this helpful?

๐Ÿ› ๏ธ

Delete AuthGrant

delete

Delete AuthGrant

Authorizations
Path parameters
idstringRequired
Responses
200
Successful response
application/json
Responseboolean
default
Error response
application/json
delete
DELETE /api/auth-grant/{id} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true

Revoke AuthGrant

post

Revoke AuthGrant

Authorizations
Path parameters
idstringRequired
Responses
200
Successful response
application/json
Responseboolean
default
Error response
application/json
post
POST /api/auth-grant/{id}/revoke HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true
  • POSTAdd AuthGrant to your profile
  • GETGet AuthGrant
  • DELETEDelete AuthGrant
  • POSTGet My AuthGrants
  • POSTUpdate AuthGrant
  • POSTRevoke AuthGrant

Get AuthGrant

get

Get AuthGrant

Authorizations
Path parameters
idstringRequired
Responses
200
Successful response
application/json
Responseany of
notOptional
or
default
Error response
application/json
get
GET /api/auth-grant/{id} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Add AuthGrant to your profile

post

Add AuthGrant to your profile

Authorizations
Body
namestringOptional
descriptionstringOptional
scopestringOptional
expiresAtstring ยท date-time | nullableOptional
Responses
200
Successful response
application/json
Responsestring
default
Error response
application/json
post
POST /api/auth-grant/create HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "name": "text",
  "description": "text",
  "scope": "text",
  "expiresAt": "2025-05-24T12:22:05.126Z"
}
text

Get My AuthGrants

post

Get My AuthGrants

Authorizations
Body
limitnumberOptional
cursorstringOptional
Responses
200
Successful response
application/json
default
Error response
application/json
post
POST /api/profile/auth-grants HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "limit": 1,
  "cursor": "text",
  "query": {
    "id": "text",
    "name": "text",
    "description": "text",
    "status": "active"
  }
}
[
  {
    "id": "text",
    "name": "text",
    "description": "text",
    "challenge": "text",
    "status": "revoked",
    "scope": "text",
    "createdAt": "2025-05-24T12:22:05.126Z",
    "expiresAt": "2025-05-24T12:22:05.126Z"
  }
]

Update AuthGrant

post

Update AuthGrant

Authorizations
Path parameters
idstringRequired
Body
Responses
200
Successful response
application/json
Responseboolean
default
Error response
application/json
post
POST /api/auth-grant/update/{id} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "updates": {
    "name": "text",
    "description": "text"
  }
}
true