修改租户详情 - Authok管理API

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Body 参数application/json

change_password

object

修改密码配置

必需

enabled

boolean

必需

html

string

必需

device_flow

object

设备流程配置

必需

charset

string

必需

mask

string

必需

guardian_mfa_page

object

多因素认证配置

必需

enabled

boolean

必需

html

string

必需

default_audience

string

必需

默认audience

default_directory

string

默认client

必需

error_page

object

错误页面定义

必需

html

string

必需

show_log_link

boolean

必需

url

string

必需

flags

object

标记

必需

change_pwd_flow

boolean

必需

enable_client_connections

boolean

必需

enable_apis_section

boolean

必需

enable_pipeline2

boolean

必需

enable_dynamic_client_registration

boolean

必需

enable_custom_domain_in_emails

boolean

必需

allow_legacy_tokeninfo_endpoint

boolean

必需

enable_legacy_profile

boolean

必需

enable_idtoken_api2

boolean

必需

enable_public_signup_user_exists_error

boolean

必需

allow_legacy_delegation_grant_types

boolean

必需

allow_legacy_ro_grant_types

boolean

必需

enable_sso

boolean

必需

disable_clickjack_protection_headers

boolean

必需

no_disclose_enterprise_connections

boolean

必需

disable_management_api_sms_obfuscation

boolean

必需

enforce_client_authentication_on_passwordless_start

boolean

必需

trust_azure_adfs_email_verified_connection_property

boolean

必需

enable_adfs_waad_email_verification

boolean

必需

revoke_refresh_token_grant

boolean

必需

dashboard_log_streams_next

boolean

必需

dashboard_insights_view

boolean

必需

display_name

string

可读名称

必需

picture

string

logo链接

必需

support_email

string

必需

技术支持的email

support_url

string

技术支持的链接

必需

allowed_logout_urls

array[string]

允许的退登url

必需

session_lifetime

integer

会话超时时间(秒)

必需

idle_session_lifetime

integer

必需

空闲会话过期时间(秒)

sandbox_version

string

沙箱版本

必需

default_redirection_uri

string

默认登录跳转链接

必需

enabled_locales

array[string]

开启的语言地区

必需

session_cookie

object

必需

会话cookie相关配置

mode

string

必需

示例

{
    "change_password": {
        "enabled": false,
        "html": "eu ipsum esse non quis"
    },
    "device_flow": {
        "charset": "in pariatur dolore",
        "mask": "nulla"
    },
    "guardian_mfa_page": {
        "enabled": false,
        "html": "consequat reprehenderit proident sit"
    },
    "default_audience": "commodo Ut qui nulla eu",
    "default_directory": "Duis proident",
    "error_page": {
        "html": "irure Duis in mollit adipisicing",
        "show_log_link": true,
        "url": "http://mjtoikbc.mr/wbkg"
    },
    "flags": {
        "change_pwd_flow_v1": false,
        "enable_client_connections": false,
        "enable_apis_section": false,
        "enable_pipeline2": true,
        "enable_dynamic_client_registration": false,
        "enable_custom_domain_in_emails": true,
        "allow_legacy_tokeninfo_endpoint": false,
        "enable_legacy_profile": false,
        "enable_idtoken_api2": false,
        "enable_public_signup_user_exists_error": false,
        "allow_legacy_delegation_grant_types": true,
        "allow_legacy_ro_grant_types": true,
        "enable_sso": false,
        "disable_clickjack_protection_headers": true,
        "no_disclose_enterprise_connections": true,
        "disable_management_api_sms_obfuscation": true,
        "enforce_client_authentication_on_passwordless_start": false,
        "trust_azure_adfs_email_verified_connection_property": false,
        "enable_adfs_waad_email_verification": false,
        "revoke_refresh_token_grant": false,
        "dashboard_log_streams_next": true,
        "dashboard_insights_view": true
    },
    "display_name": "他院部号果信目",
    "picture": "http://dummyimage.com/400x400",
    "support_email": "b.uzio@qq.com",
    "support_url": "http://wet.bt/necyfhva",
    "allowed_logout_urls": [
        "incididunt adipisicing enim",
        "elit in sit",
        "incididunt laboris eiusmod magna quis",
        "laboris do officia mollit"
    ],
    "session_lifetime": 515542224399,
    "idle_session_lifetime": 20,
    "sandbox_version": "consectetur ad Lorem",
    "default_redirection_uri": "sed cillum amet laborum ad",
    "enabled_locales": [
        "qui dolore quis dolor",
        "magna sit qui nulla"
    ],
    "session_cookie": {
        "mode": "sunt Excepteur"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request PATCH 'https://..authok.cn/api/v1/tenants/settings' \
--header 'Content-Type: application/json' \
--data-raw '{
    "change_password": {
        "enabled": false,
        "html": "eu ipsum esse non quis"
    },
    "device_flow": {
        "charset": "in pariatur dolore",
        "mask": "nulla"
    },
    "guardian_mfa_page": {
        "enabled": false,
        "html": "consequat reprehenderit proident sit"
    },
    "default_audience": "commodo Ut qui nulla eu",
    "default_directory": "Duis proident",
    "error_page": {
        "html": "irure Duis in mollit adipisicing",
        "show_log_link": true,
        "url": "http://mjtoikbc.mr/wbkg"
    },
    "flags": {
        "change_pwd_flow_v1": false,
        "enable_client_connections": false,
        "enable_apis_section": false,
        "enable_pipeline2": true,
        "enable_dynamic_client_registration": false,
        "enable_custom_domain_in_emails": true,
        "allow_legacy_tokeninfo_endpoint": false,
        "enable_legacy_profile": false,
        "enable_idtoken_api2": false,
        "enable_public_signup_user_exists_error": false,
        "allow_legacy_delegation_grant_types": true,
        "allow_legacy_ro_grant_types": true,
        "enable_sso": false,
        "disable_clickjack_protection_headers": true,
        "no_disclose_enterprise_connections": true,
        "disable_management_api_sms_obfuscation": true,
        "enforce_client_authentication_on_passwordless_start": false,
        "trust_azure_adfs_email_verified_connection_property": false,
        "enable_adfs_waad_email_verification": false,
        "revoke_refresh_token_grant": false,
        "dashboard_log_streams_next": true,
        "dashboard_insights_view": true
    },
    "display_name": "他院部号果信目",
    "picture": "http://dummyimage.com/400x400",
    "support_email": "b.uzio@qq.com",
    "support_url": "http://wet.bt/necyfhva",
    "allowed_logout_urls": [
        "incididunt adipisicing enim",
        "elit in sit",
        "incididunt laboris eiusmod magna quis",
        "laboris do officia mollit"
    ],
    "session_lifetime": 515542224399,
    "idle_session_lifetime": 20,
    "sandbox_version": "consectetur ad Lorem",
    "default_redirection_uri": "sed cillum amet laborum ad",
    "enabled_locales": [
        "qui dolore quis dolor",
        "magna sit qui nulla"
    ],
    "session_cookie": {
        "mode": "sunt Excepteur"
    }
}'

返回响应

🟢200成功

application/json

Body

name

string

租户唯一标识

必需

display_name

string

可读名称

可选

picture

string

logo链接

可选

default_redirection_uri

string

默认跳转链接

可选

region

string

租户所在区域

必需

flags

object

开关

必需

change_pwd_flow

boolean

开启变更密码流程

可选

enable_client_connections

boolean

可选

开启应用身份源, 不开启则全部身份源对全部应用都可用

示例

{
    "name": "将维江声同各办",
    "region": "cn",
    "flags": {
        "enable_client_connections": true,
        "change_pwd_flow": true
    },
    "display_name": "金开并住况",
    "picture": "https://fuwnwa.pr/gcsygwub",
    "default_redirection_uri": "https://myapp.com/login"
}