CreateSCIMGroup - 创建 SCIM 组

更新时间:
复制 MD 格式

适用版本

中心版、Region版

服务接入点与授权信息

产品

资源

所需权限

组织管理

SCIM

读写

请求语法

中心版

POST https://{domain}/oapi/v1/platform/organizations/{organizationId}/scim/v2/Groups

Region版

POST https://{domain}/oapi/v1/platform/scim/v2/Groups

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

是

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数 #1

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

是

组织 ID。

-

object

body

否

displayName

string

body

是

externalId

string

body

否

id

string

body

否

members

array

body

否

-

object

body

否

$ref

string

body

否

display

string

body

否

type

string

body

否

value

string

body

否

meta

object

body

否

created

string

body

否

lastModified

string

body

否

location

string

body

否

resourceType

string

body

否

version

string

body

否

schemas

array[string]

body

是

urn:alibaba:params:scim:schemas:extension:nezha:2.0:Group

object

body

否

parentExternalId

string

body

否

parentId

string

body

否

path

string

body

否

请求参数 #2

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

是

组织 ID

-

object

body

否

displayName

string

body

是

externalId

string

body

否

id

string

body

否

members

array

body

否

-

object

body

否

$ref

string

body

否

display

string

body

否

type

string

body

否

value

string

body

否

meta

object

body

否

created

string

body

否

lastModified

string

body

否

location

string

body

否

resourceType

string

body

否

version

string

body

否

schemas

array[string]

body

是

urn:alibaba:params:scim:schemas:extension:nezha:2.0:Group

object

body

否

parentExternalId

string

body

否

parentId

string

body

否

path

string

body

否

请求示例 #1

中心版

curl -X 'POST' \
  'https://{domain}/oapi/v1/platform/organizations/{organizationId}/scim/v2/Groups' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "displayName": "",
        "externalId": "",
        "id": "",
        "members": [
            {
                "$ref": "",
                "display": "",
                "type": "",
                "value": ""
            }
        ],
        "meta": {
            "created": "",
            "lastModified": "",
            "location": "",
            "resourceType": "",
            "version": ""
        },
        "schemas": [
            
        ],
        "urn:alibaba:params:scim:schemas:extension:nezha:2.0:Group": {
            "parentExternalId": "",
            "parentId": "",
            "path": ""
        }
    }'

Region版

curl -X 'POST' \
  'https://{domain}/oapi/v1/platform/scim/v2/Groups' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "displayName": "",
        "externalId": "",
        "id": "",
        "members": [
            {
                "$ref": "",
                "display": "",
                "type": "",
                "value": ""
            }
        ],
        "meta": {
            "created": "",
            "lastModified": "",
            "location": "",
            "resourceType": "",
            "version": ""
        },
        "schemas": [
            
        ],
        "urn:alibaba:params:scim:schemas:extension:nezha:2.0:Group": {
            "parentExternalId": "",
            "parentId": "",
            "path": ""
        }
    }'

请求示例 #2

中心版

curl -X 'POST' \
  'https://{domain}/oapi/v1/platform/organizations/{organizationId}/scim/v2/Groups' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "displayName": "",
        "externalId": "",
        "id": "",
        "members": [
            {
                "$ref": "",
                "display": "",
                "type": "",
                "value": ""
            }
        ],
        "meta": {
            "created": "",
            "lastModified": "",
            "location": "",
            "resourceType": "",
            "version": ""
        },
        "schemas": [
            
        ],
        "urn:alibaba:params:scim:schemas:extension:nezha:2.0:Group": {
            "parentExternalId": "",
            "parentId": "",
            "path": ""
        }
    }'

Region版

curl -X 'POST' \
  'https://{domain}/oapi/v1/platform/scim/v2/Groups' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "displayName": "",
        "externalId": "",
        "id": "",
        "members": [
            {
                "$ref": "",
                "display": "",
                "type": "",
                "value": ""
            }
        ],
        "meta": {
            "created": "",
            "lastModified": "",
            "location": "",
            "resourceType": "",
            "version": ""
        },
        "schemas": [
            
        ],
        "urn:alibaba:params:scim:schemas:extension:nezha:2.0:Group": {
            "parentExternalId": "",
            "parentId": "",
            "path": ""
        }
    }'

返回参数

参数

类型

描述

示例值

-

object

displayName

string

externalId

string

id

string

members

array

-

object

$ref

string

display

string

type

string

value

string

meta

object

created

string

lastModified

string

location

string

resourceType

string

version

string

schemas

array[string]

urn:alibaba:params:scim:schemas:extension:nezha:2.0:Group

object

parentExternalId

string

parentId

string

path

string

返回示例

{
    "displayName": "",
    "externalId": "",
    "id": "",
    "members": [
        {
            "$ref": "",
            "display": "",
            "type": "",
            "value": ""
        }
    ],
    "meta": {
        "created": "",
        "lastModified": "",
        "location": "",
        "resourceType": "",
        "version": ""
    },
    "schemas": [
        
    ],
    "urn:alibaba:params:scim:schemas:extension:nezha:2.0:Group": {
        "parentExternalId": "",
        "parentId": "",
        "path": ""
    }
}

错误码

访问错误码中心查看 API 相关错误码。