创建邀请 - Authok管理API

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

id

string

必需

Body 参数application/json

inviter

object

邀请人

必需

邀请人

name

string

邀请人姓名

必需

邀请人姓名

invitee

object

被邀请人

必需

被邀请人

email

string

被邀请人邮箱

必需

被邀请人邮箱

client_id

string

应用ID

必需

应用ID

connection

string

身份源唯一标识

必需

身份源唯一标识

app_metadata

object

应用元数据

必需

应用元数据

user_metadata

object

用户元数据

必需

用户元数据

ttl_sec

integer

过期时间(秒)

必需

过期时间(秒)

roles

array[string]

角色列表

必需

角色列表

send_invitation_email

boolean

是否发送邀请邮件

必需

是否发送邀请邮件

示例

{
    "inviter": {
        "name": "string"
    },
    "invitee": {
        "email": "string"
    },
    "client_id": "string",
    "connection": "string",
    "app_metadata": {},
    "user_metadata": {},
    "ttl_sec": 0,
    "roles": [
        "string"
    ],
    "send_invitation_email": true
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request POST 'https://..authok.cn/api/v1/organizations//invitations' \
--header 'Content-Type: application/json' \
--data-raw '{
    "inviter": {
        "name": "string"
    },
    "invitee": {
        "email": "string"
    },
    "client_id": "string",
    "connection": "string",
    "app_metadata": {},
    "user_metadata": {},
    "ttl_sec": 0,
    "roles": [
        "string"
    ],
    "send_invitation_email": true
}'

返回响应

🟢200成功

application/json

Body

id

string

必需

organization_id

string

组织ID

必需

inviter

object

邀请人

必需

phone_number

string

邀请人手机号

必需

邀请人手机号

email

string

邀请人邮箱

必需

邀请人邮箱

user_id

string

邀请人ID

必需

邀请人ID

invitee

object

邀请人

必需

被邀请人

email

string

被邀请人邮箱

必需

被邀请人邮箱

phone_number

string

被邀请人邮箱

必需

手机号

invitation_url

string

邀请链接

必需

created_at

string

邀请创建时间

必需

expires_at

string

邀请过期时间

必需

client_id

string

应用ID

必需

应用ID

connection

string

身份源ID

必需

身份源ID

app_metadata

object

应用元数据

必需

应用元数据

user_metadata

object

用户元数据

必需

用户元数据

roles

array[string]

角色列表

必需

角色列表

ticket

string

票据ID

必需

票据ID

示例

{
    "id": "inv_00000000000000000001",
    "organization_id": "org_00000000000000000001",
    "inviter": {
        "name": "李雷",
    },
    "invitee": {
        "email": "fioman@qq.com"
    },
    "invitation_url": "http://yourdomain/login?invitation=0Av_TNjkyXqEmnIPRleSrIanNL6tZ7SahgUo&organization=org_gyGqtWJ-z4GgmZmPurMZ7Aqu&organization_name=a",
    "created_at": "2022-03-23 16:50:54",
    "expires_at": "2021-03-30 16:50:54",
    "client_id": "LsBkF4M6wXNDfvazjNaQzAXogM7W2f-p",
    "connection": "database1",
    "app_metadata": {},
    "user_metadata": {},
    "roles": [
        "role_00000000000000000001"
    ],
    "ticket": "0Av_TNjkyXqEmnIPRleSrIanNL6tZ7SahgUo"
}