Auth Grants

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
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-07-03T03:27:52.344Z"
}
text

Get AuthGrant

get

Get AuthGrant

Authorizations
Path parameters
idstringRequired
Responses
200
Successful response
application/json
get
GET /api/auth-grant/{id} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "text",
  "name": "text",
  "description": "text",
  "challenge": "text",
  "status": "revoked",
  "scope": "text",
  "createdAt": "2025-07-03T03:27:52.344Z",
  "expiresAt": "2025-07-03T03:27:52.344Z"
}

Delete AuthGrant

delete

Delete AuthGrant

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

Get My AuthGrants

post

Get My AuthGrants

Authorizations
Body
limitnumberOptional
cursorstringOptional
Responses
200
Successful 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-07-03T03:27:52.344Z",
    "expiresAt": "2025-07-03T03:27:52.344Z"
  }
]

Update AuthGrant

post

Update AuthGrant

Authorizations
Path parameters
idstringRequired
Body
Responses
200
Successful response
application/json
Responseboolean
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

Revoke AuthGrant

post

Revoke AuthGrant

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

Was this helpful?