IDMesh APIs

创建应用

POST

/v1/applications

type_mgmtdocprogrammer-docmodule_application

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

name

string

应用名称

必需

type

string

应用类型

必需

1，自建应用，2模板应用（市场应用）

domain_sn

string

域名

必需

template_id

string

模板id

可选

不填写则代表自建应用

category

string

应用分类

必需

1 标准web应用，2单页web应用，3客户端应用，4后端服务

descr

string

应用描述

可选

logo

string

logo路径

可选

格式为：http://ip:port/logo.png

login_url

string

登录路径

可选

redirect_url

string

重定向路径

可选

logout_url

string

登出路径

可选

sub_account_policy

string

子账号策略

可选

1启用，0不启用，启用后单点登录返回

sys_ext_props

object

系统扩展字段

可选

kv字典数据

free_ext_props

object

自定义扩展属性

必需

kv字典数据

protocol_type

string

认证协议

可选

默认 oidc

protocol_prop

object

认证协议配置

可选

默认 oidc 相关配置

acs_url

string

可选

sp_entity

string

可选

response_attr

array [object {3}]

可选

digest_algorithm

string

可选

lifetime_in_seconds

number

可选

signature_algorithm

string

可选

name_identifier_format

string

可选

authn_context_class_ref

string

可选

saml_response_signing_key

string

可选

saml_response_signing_cert

string

可选

saml_response_signing_cert_fingerprint

string

可选

config_prop

object

应用配置

可选

status

string

可选

tenant_id

string

可选

mfa_config

object

可选

reg_policy

array[string]

可选

mfa_enabled

string

可选

sso_enabled

string

可选

developer_id

string

可选

access_policy

object

可选

allowed_reg_method

object

可选

default_reg_method

string

可选

allowed_login_method

object

可选

default_login_method

string

可选

allowed_social_login_provider

object

可选

template_params

object

应用模板参数

可选

version

string

应用模板版本

必需

params

object

应用模板参数

可选

示例

{
    "name": "string",
    "type": "string",
    "domain_sn": "string",
    "template_id": "string",
    "category": "string",
    "descr": "string",
    "logo": "string",
    "login_url": "string",
    "redirect_url": "string",
    "logout_url": "string",
    "sub_account_policy": "string",
    "sys_ext_props": {},
    "free_ext_props": {},
    "protocol_type": "string",
    "protocol_prop": {
        "acs_url": "string",
        "sp_entity": "string",
        "response_attr": [
            {
                "value": "string",
                "attribute": "string",
                "nameFormat": "string"
            }
        ],
        "digest_algorithm": "string",
        "lifetime_in_seconds": 0,
        "signature_algorithm": "string",
        "name_identifier_format": "string",
        "authn_context_class_ref": "string",
        "saml_response_signing_key": "string",
        "saml_response_signing_cert": "string",
        "saml_response_signing_cert_fingerprint": "string"
    },
    "config_prop": {
        "status": "string",
        "tenant_id": "string",
        "mfa_config": {},
        "reg_policy": [
            "string"
        ],
        "mfa_enabled": "string",
        "sso_enabled": "string",
        "developer_id": "string",
        "access_policy": {
            "forget_password": [
                "string"
            ]
        },
        "allowed_reg_method": {},
        "default_reg_method": "string",
        "allowed_login_method": {
            "name": "string"
        },
        "default_login_method": "string",
        "allowed_social_login_provider": {
            "wechat_scan_qr": 0,
            "dingding_scan_qr": 0
        }
    },
    "template_params": {
        "version": "string",
        "params": {}
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/v1/applications' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "type": "string",
    "domain_sn": "string",
    "template_id": "string",
    "category": "string",
    "descr": "string",
    "logo": "string",
    "login_url": "string",
    "redirect_url": "string",
    "logout_url": "string",
    "sub_account_policy": "string",
    "sys_ext_props": {},
    "free_ext_props": {},
    "protocol_type": "string",
    "protocol_prop": {
        "acs_url": "string",
        "sp_entity": "string",
        "response_attr": [
            {
                "value": "string",
                "attribute": "string",
                "nameFormat": "string"
            }
        ],
        "digest_algorithm": "string",
        "lifetime_in_seconds": 0,
        "signature_algorithm": "string",
        "name_identifier_format": "string",
        "authn_context_class_ref": "string",
        "saml_response_signing_key": "string",
        "saml_response_signing_cert": "string",
        "saml_response_signing_cert_fingerprint": "string"
    },
    "config_prop": {
        "status": "string",
        "tenant_id": "string",
        "mfa_config": {},
        "reg_policy": [
            "string"
        ],
        "mfa_enabled": "string",
        "sso_enabled": "string",
        "developer_id": "string",
        "access_policy": {
            "forget_password": [
                "string"
            ]
        },
        "allowed_reg_method": {},
        "default_reg_method": "string",
        "allowed_login_method": {
            "name": "string"
        },
        "default_login_method": "string",
        "allowed_social_login_provider": {
            "wechat_scan_qr": 0,
            "dingding_scan_qr": 0
        }
    },
    "template_params": {
        "version": "string",
        "params": {}
    }
}'

返回响应

🟢200成功

application/json

Body

string

唯一标识

可选

示例

{
    "id": "string"
}

🟠400参数错误

修改于 2024-10-18 06:30:35

用户变更组织

更新应用基本信息