Xeonr Developer Docs
API Specificationxeonr.auth.api.v1.TeamsService

Describe Team Entitlement

POST
/xeonr.auth.api.v1.TeamsService/DescribeTeamEntitlement

Returns whether a team is entitled to the calling application, with the entitlement's per-product configuration.

Required scopes: auth:teams:read

Authorization

AuthorizationBearer <token>

JWT access token obtained via OAuth2 flow or service account

In: header

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1
Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

team?string
Length1 <= length <= 128
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://auth.xeonr.io/xeonr.auth.api.v1.TeamsService/DescribeTeamEntitlement" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'
{
  "entitled": true,
  "config": {
    "property1": {},
    "property2": {}
  },
  "team": {
    "teamId": "urn:xeonr:auth:team:0f3c9a2e-8f1b-4c2d-9e6a-1b2c3d4e5f60",
    "slug": "platform-core",
    "name": "Platform Core",
    "description": "string",
    "avatarUrl": "string",
    "createdAt": "2023-01-15T01:30:15.01Z"
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Delete Team POST

Deletes a team, its memberships, invitations, and entitlements. Requires team owner. **Required scopes:** `auth:teams:manage` or `auth:teams:manage:app` (the latter additionally requires the team to be entitled to the calling application)

Describe Team Membership POST

Authoritatively answers whether a subject is a member of a team, with their team role and per-application role names for the calling application. This is the product-side authorisation check for destructive or sensitive operations where a cached token claim is not fresh enough. **Required scopes:** `auth:teams:read`