RoadmapFrends

PrivateApplication

Get Private Application

get
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters
idinteger · int64Required

Private Application Id

Responses
200

Private Application found

application/json
get
/api/v1/private-application/{id}
GET /api/v1/private-application/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "name": "text",
    "description": "text",
    "defaultTokenLifetimeDays": 1,
    "customTokenClaims": {},
    "tags": [
      "text"
    ],
    "id": 1,
    "modifier": "text",
    "modifiedUtc": "2025-11-28T00:31:39.760Z",
    "hasTokens": true,
    "hasActiveTokens": true,
    "nextTokenExpiry": "2025-11-28T00:31:39.760Z"
  }
}

Update Private Application

put
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters
idinteger · int64Required

Private Application Id

Body
namestringOptional

Name of the application

descriptionstring | nullableOptional

Description of the application

defaultTokenLifetimeDaysinteger · int32 · min: 1 · max: 730Optional

Default token lifetime in days

customTokenClaimsobjectOptional

Custom token claims

tagsstring[]Optional

Tags for the application

Responses
200

Private Application updated

application/json
put
/api/v1/private-application/{id}
PUT /api/v1/private-application/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "name": "",
  "description": "",
  "defaultTokenLifetimeDays": 730,
  "customTokenClaims": {
    "iss": "https://frends61.frendsapp.com",
    "aud": "https://frends61.frendsapp.com",
    "sub": ""
  },
  "tags": []
}
{
  "data": 1
}

Delete Private Application

delete
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters
idinteger · int64Required

Private Application Id

Responses
delete
/api/v1/private-application/{id}
DELETE /api/v1/private-application/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

List Private Applications

get

If response data is empty there were no Private Applications found with the chosen filters

Authorizations
AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Query parameters
NameFilterstringOptional

Filter by name of the application

DescriptionFilterstringOptional

Filter by description of the application

TokenContentFilterstringOptional

Filter by token content

FilterModestring · enumOptionalPossible values:
TokenExpiringWithinDaysinteger · int32Optional

Filter by tokens expiring within X days

Responses
200

OK

application/json
get
/api/v1/private-application
GET /api/v1/private-application HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "defaultTokenLifetimeDays": 1,
      "customTokenClaims": {},
      "tags": [
        "text"
      ],
      "id": 1,
      "modifier": "text",
      "modifiedUtc": "2025-11-28T00:31:39.760Z",
      "hasTokens": true,
      "hasActiveTokens": true,
      "nextTokenExpiry": "2025-11-28T00:31:39.760Z"
    }
  ]
}

Create Private Application

post
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Body
namestringOptional

Name of the application

descriptionstring | nullableOptional

Description of the application

defaultTokenLifetimeDaysinteger · int32 · min: 1 · max: 730Optional

Default token lifetime in days

customTokenClaimsobjectOptional

Custom token claims

tagsstring[]Optional

Tags for the application

Responses
post
/api/v1/private-application
POST /api/v1/private-application HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "name": "",
  "description": "",
  "defaultTokenLifetimeDays": 730,
  "customTokenClaims": {
    "iss": "https://frends61.frendsapp.com",
    "aud": "https://frends61.frendsapp.com",
    "sub": ""
  },
  "tags": []
}
{
  "data": 1
}

List Private Application Tokens

get

If response data is empty there were no tokens found for the Private Application

Authorizations
AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters
idinteger · int64Required

Private Application Id

Query parameters
PageNumberinteger · int32Optional
PageSizeinteger · int32Optional
NameFilterstringOptional

Filter by name of the token

IsExpiredFilterbooleanOptional

Filter by token expiry status

IsRevokedFilterbooleanOptional

Filter by token revocation status

ClaimKeyFilterstringOptional

Filter by token claim key

FilterModestring · enumOptionalPossible values:
Responses
200

OK

application/json
get
/api/v1/private-application/{id}/tokens
GET /api/v1/private-application/{id}/tokens HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "tokenCount": 1,
    "tokens": [
      {
        "id": 1,
        "name": "text",
        "expiryTimeUtc": "2025-11-28T00:31:39.760Z",
        "createTimeUtc": "2025-11-28T00:31:39.760Z",
        "tokenClaims": {},
        "creator": "text",
        "revoker": "text",
        "revokeTimeUtc": "2025-11-28T00:31:39.760Z",
        "revokeReason": "text",
        "fullToken": "text",
        "payloadOnly": "text"
      }
    ]
  }
}

Create Private Application Token

post
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters
idinteger · int64Required

Private Application Id

Body
namestringOptional

Name of the token

tokenLifetimeDaysinteger · int32 | nullableOptional

Token lifetime in days

tokenClaimsobjectOptional

Token claims

Responses
post
/api/v1/private-application/{id}/tokens
POST /api/v1/private-application/{id}/tokens HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "name": "",
  "tokenLifetimeDays": 730,
  "tokenClaims": {
    "iss": "https://frends61.frendsapp.com",
    "aud": "https://frends61.frendsapp.com",
    "sub": ""
  }
}
{
  "data": 1
}

Get Private Application Token

get
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters
idinteger · int64Required

Private Application Id

tokenIdinteger · int64Required

Private Application Token Id

Responses
200

Private Application token found

application/json
get
/api/v1/private-application/{id}/tokens/{tokenId}
GET /api/v1/private-application/{id}/tokens/{tokenId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "name": "text",
    "expiryTimeUtc": "2025-11-28T00:31:39.760Z",
    "createTimeUtc": "2025-11-28T00:31:39.760Z",
    "tokenClaims": {},
    "creator": "text",
    "revoker": "text",
    "revokeTimeUtc": "2025-11-28T00:31:39.760Z",
    "revokeReason": "text",
    "fullToken": "text",
    "payloadOnly": "text"
  }
}

Regenerate Private Application Token

post
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters
idinteger · int64Required

Private Application Id

tokenIdinteger · int64Required

Private Application Token Id

Responses
post
/api/v1/private-application/{id}/tokens/{tokenId}
POST /api/v1/private-application/{id}/tokens/{tokenId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": 1
}

Revoke all tokens of Private Application

post
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters
idinteger · int64Required

Private Application Id

Body
stringOptional
Responses
200

Number of Private Application Tokens revoked

application/json
post
/api/v1/private-application/{id}/tokens/revocation
POST /api/v1/private-application/{id}/tokens/revocation HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
{
  "data": 1
}

Revoke token of Private Application

post
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters
idinteger · int64Required

Private Application Id

tokenIdinteger · int64Required

Private Application Token Id

Body
stringOptional
Responses
200

Private Application token revoked

No content
post
/api/v1/private-application/{id}/tokens/{tokenId}/revocation
POST /api/v1/private-application/{id}/tokens/{tokenId}/revocation HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
No content
PreviousFrendsAiEndpointBuilderNextProcessDeployments

Was this helpful?