跳转至

身份验证 - 云

在 Tagetik Cloud 的某些区域,提供了新的 API 访问服务,支持不同的身份验证策略,称为 API Gateway。请参阅发行说明以了解此服务在哪些区域可用。

要通过此服务执行 API 请求,请登录应用程序,导航到 'Authentication Credentials' 页面,点击您的用户名,然后点击下拉菜单中的 'Authentication Credentials' 项。

要生成凭据,请从 Type 下拉菜单中指定所需类型,并填写必填字段(可能因所选类型而异)。

点击 'Generate' 按钮后,将显示一个包含 JSON 的窗口。该 JSON 表示生成的凭据以及一些附加信息;您可以通过点击右侧的复制按钮或左下角的 'copy and close' 按钮来复制 JSON 的内容。

重要:管理员也可以为特定的本地用户生成凭据。

管理员必须启用功能 0000016 和 R000024。

通过从 Repository 访问用户管理页面,可以选择一个本地用户,并点击操作菜单中可用的 'Authentication Credentials' 菜单项,这样

管理员将被重定向到所选用户的 'Authentication Credentials' 页面。

使用示例

在决定要调用哪些公共 API(例如 SCIM API)后,打开所需的 REST 客户端(例如 Postman)。

要调用的 URL 必须是 JSON 中的 'url endpoint' 与 API URL 的拼接。

API 密钥

生成 API 密钥凭据将产生如下 JSON:

{

"secret key": "YOUR_SECRET",

"endpoint url": ".api.saastagetik.com/api-key"

}

在 Postman 授权区域中,指定 'API key' 类型,然后填写以下字段:

  • Key:apiKey(此值为必填,且必须按此方式书写)
  • Value:来自 JSON 的 YOUR_SECRET
  • Add to:Header

要调用 SCIM API,URL 变为:

.api.saastagetik.com/api-key/scim/v2/Users/USER_CODE

Basic

生成 Basic 凭据将产生如下 JSON:

{

"username": "COD_MT-YOUR_USERNAME",

"password": "YOUR_PASSWORD",

"endpoint url": ".api.saastagetik.com/basic"

}

在 Postman 授权区域中,指示 'Basic Auth' 类型,然后填写必填字段:

  • Username:COD_MT-YOUR_USERNAME
  • Password:YOUR_PASSWORD

要调用 SCIM API,URL 变为:

.api.saastagetik.com/basic/scim/v2/Users/USER_CODE

OAuth 2.0

生成 OAuth 2.0 凭据将产生如下 JSON:

{

"client id": "YOUR_CLIENT_ID",

"client secret": "YOUR_CLIENT_SECRET",

"access token url": ".api.saastagetik.com/oauth2/oauth2/token",

"endpoint url": ".api.saastagetik.com/oauth2"

}

在 Postman 授权区域中,指示 'OAuth 2.0' 类型。可以使用 Postman 的 'Configure New Token' 功能获取令牌:

  • Grant type:Client credentials
  • Access Token URL:来自 JSON 的 access token url
  • Client ID:YOUR_CLIENT_ID
  • Client Secret:YOUR_CLIENT_SECRET
  • Client Authentication:Send as Auth Basic Header

要调用 SCIM API,URL 变为:

.api.saastagetik.com/oauth2/scim/v2/Users/USER_CODE

JWT

生成 JWT 凭据将产生如下 JSON:

{

"algorithm": "HS256",

"key": "YOUR_KEY",

"secret": "YOUR_SECRET",

"endpoint url": ".api.saastagetik.com/jwt"

}

可以使用 https://jwt.io/: 获取有效的 JWT 令牌

在 header 部分指定 HS256 算法(可从下拉菜单中选择),在 payload 部分指定由 "iss" 键和值 YOUR_KEY 组成的 JSON,在 Verify Signature 部分用 YOUR_SECRET 填写空的 secret 空间(勾选 "secret base64 encoded")。

生成的 secret 在左侧部分可见(已编码)。

在 Postman 的授权区域中,指示类型 'Bearer Token',然后填写必填字段:

  • Token:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJZT1VSX0tFWSJ9.lt5n0pwXjcQPB4cbf1Vb8Vla2tAxVl-iSBjmaeojs7g

要调用 SCIM API,URL 变为:

.api.saastagetik.com/jwt/scim/v2/Users/USER_CODE