Xeonr Developer Docs

Invite an email address to a team (owner)

POST
/xeonr.auth.private.v1.TeamsService/CreateTeamInvitation

Authorization

BearerAuth
AuthorizationBearer <token>

JWT access token for internal API access. Requires 'private' scope for most endpoints, 'admin' scope for administrative operations.

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
email?string
Formatemail
Length3 <= length <= 128
role?string

The subject's governance role within a team. Product-level permissions are carried separately as per-application role names (ApplicationRole).

Value in"TEAM_ROLE_UNSPECIFIED" | "TEAM_ROLE_OWNER" | "TEAM_ROLE_MEMBER"
applicationRoles?

Roles granted on acceptance, keyed by application slug.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://auth.xeonr.io/xeonr.auth.private.v1.TeamsService/CreateTeamInvitation" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'
{
  "invitation": {
    "invitation": {
      "invitationId": "b8a7c6d5-e4f3-4a2b-9c8d-7e6f5a4b3c2d",
      "teamId": "string",
      "email": "[email protected]",
      "role": "TEAM_ROLE_UNSPECIFIED",
      "applicationRoles": [
        "string"
      ],
      "invitedBy": "urn:xeonr:auth:uid:user:123",
      "expiresAt": "2023-01-15T01:30:15.01Z",
      "createdAt": "2023-01-15T01:30:15.01Z"
    },
    "applicationRoles": {
      "property1": {
        "roles": [
          "string"
        ]
      },
      "property2": {
        "roles": [
          "string"
        ]
      }
    }
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}