Authok管理API
  1. 组织(Organization)
Authok管理API
  • 快速开始
    • 获取Token
  • 身份源(Connection)
    • 创建身份源
      POST
    • 根据ID查找身份源
      GET
    • 更新身份源
      PATCH
    • 删除身份源
      DELETE
    • 获取身份源列表
      GET
    • 获取身份源的状态
      GET
    • 删除身份源的给定用户
      DELETE
  • 应用(Client)
    • 查找应用
    • 创建应用
    • 更新应用
    • 删除应用
    • 获取应用列表
    • 轮换密钥
  • 资源服务器(ResourceServer)
    • 创建资源服务器
    • 获取资源服务器
    • 更新资源服务器
    • 删除资源服务器
    • 获取资源服务器列表
  • 用户(User)
    • 创建用户
    • 获取用户详情
    • 修改用户详情
    • 删除用户
    • 分页查找用户
    • 给用户添加权限
    • 删除用户的权限
    • 获取用户的权限列表
    • 获取用户的角色列表
    • 给用户添加角色
    • 删除用户的角色
    • 关联用户
    • 解除用户关联
    • 获取用户所在的组织列表
  • 角色(Role)
    • 创建角色
    • 获取角色信息
    • 更新角色信息
    • 删除角色
    • 获取角色列表
    • 获取角色的权限列表
    • 删除角色的权限
    • 分配权限给角色
    • 获取角色的用户列表
    • 分配角色给用户
    • 从给定角色中移除用户
  • 分组(Group)
  • 租户(Tenant)
    • 获取当前租户详情
    • 修改租户详情
  • 组织(Organization)
    • 创建组织
      POST
    • 获取组织详情
      GET
    • 更新组织
      PATCH
    • 删除组织
      DELETE
    • 获取组织列表
      GET
    • 根据标识符查找组织
      GET
    • 获取组织开启的身份源
      GET
    • 获取组织的成员列表
      GET
    • 从组织中删除成员
      DELETE
    • 添加成员到组织
      POST
    • 获取组织的邀请列表
      GET
    • 创建邀请
      POST
    • 获取邀请详情
      GET
    • 删除邀请
      DELETE
    • 获取组织开启的身份源列表
      GET
    • 给组织添加身份源
      POST
    • 获取组织开启的身份源详情
      GET
    • 从组织中删除给定的身份源
      DELETE
    • 修改组织关联的身份源配置
      PATCH
    • 获取成员关联的角色列表
      GET
  • 动作(Action)
    • 创建动作
    • 获取动作列表
    • 更新动作
    • 删除动作
    • 测试动作
    • 获取触发器列表
    • 获取触发器/动作绑定列表
    • 更新触发器/动作绑定
  • 授权(Grant)
  • 应用授权(ClientGrant)
    • 创建应用授权
    • 查找应用授权
    • 更新应用授权
    • 删除应用授权
    • 获取应用授权列表
  • 日志(Log)
  • 自定义域名(CusomDomain)
    • 创建自定义域名
    • 获取自定义域名
    • 更新自定义域名
    • 删除自定义域名
    • 获取自定义域名列表
    • 验证自定义域名
  • 密钥(Key)
    • 获取应用的所有密钥列表
    • 根据ID获取给定密钥
    • 轮换密钥
    • 撤销密钥
  • 任务(Job)
  • 多因素认证(MFA)
  • 安全防护(AttackProtection)
  • 品牌化(Branding)
  1. 组织(Organization)

创建邀请

POST
/api/v1/organizations/{id}/invitations

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Path 参数

Body 参数application/json

示例
{
    "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
请求示例请求示例
Shell
JavaScript
Java
Swift
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": "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"
}
修改于 2022-03-20 11:50:21
上一页
获取组织的邀请列表
下一页
获取邀请详情
Built with