UserDirectory

User directory service management for system LDAP unified authentication login

---

Query the list of user directory

GET

/api/v1/user/directory

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/user/directory

试验场

服务器

授权

UserHttpBearer

示例

cURL

JavaScript

PHP

Python

---

Replace user directory

PUT

/api/v1/user/directory

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 0,

"sequence": 0,

"server": {

"name": "XCanLdap",

"directoryType": "OPENLDAP",

"host": "ldap.example.com",

"port": 389,

"ssl": false,

"username": "cn=admin,dc=example,dc=org",

"password": "admin"

},

"schema": {

"baseDn": "dc=example,dc=org",

"additionalUserDn": "ou=user",

"additionalGroupDn": "ou=group"

},

"userSchema": {

"objectClass": "posixAccount",

"objectFilter": "(objectclass=posixAccount)",

"usernameAttribute": "uid",

"firstNameAttribute": "givenName",

"lastNameAttribute": "sn",

"displayNameAttribute": "cn",

"emailAttribute": "mail",

"mobileAttribute": "mobile",

"passwordAttribute": "userPassword",

"passwordEncoderType": "string",

"ignoreSameIdentityUser": true

},

"groupSchema": {

"objectClass": "posixGroup",

"objectFilter": "(objectClass=posixGroup)",

"nameAttribute": "cn",

"descriptionAttribute": "string",

"ignoreSameNameGroup": true

},

"membershipSchema": {

"groupMemberAttribute": "memberUid",

"memberGroupAttribute": "gidNumber"

}

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/user/directory

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Add user directory

POST

/api/v1/user/directory

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"sequence": 0,

"server": {

"name": "XCanLdap",

"directoryType": "OPENLDAP",

"host": "ldap.example.com",

"port": 389,

"ssl": false,

"username": "cn=admin,dc=example,dc=org",

"password": "admin"

},

"schema": {

"baseDn": "dc=example,dc=org",

"additionalUserDn": "ou=user",

"additionalGroupDn": "ou=group"

},

"userSchema": {

"objectClass": "posixAccount",

"objectFilter": "(objectclass=posixAccount)",

"usernameAttribute": "uid",

"firstNameAttribute": "givenName",

"lastNameAttribute": "sn",

"displayNameAttribute": "cn",

"emailAttribute": "mail",

"mobileAttribute": "mobile",

"passwordAttribute": "userPassword",

"passwordEncoderType": "string",

"ignoreSameIdentityUser": true

},

"groupSchema": {

"objectClass": "posixGroup",

"objectFilter": "(objectClass=posixGroup)",

"nameAttribute": "cn",

"descriptionAttribute": "string",

"ignoreSameNameGroup": true

},

"membershipSchema": {

"groupMemberAttribute": "memberUid",

"memberGroupAttribute": "gidNumber"

}

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/user/directory

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Synchronize the users and groups from user directory

PUT

/api/v1/user/directory/{id}/sync

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Directory id

类型integer

必填

format"int64"

响应

Synchronize successfully

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/user/directory/{id}/sync

试验场

服务器

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Synchronize the users and groups from user directories

PUT

/api/v1/user/directory/sync

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

响应

Synchronize successfully

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/user/directory/sync

试验场

服务器

授权

UserHttpBearer

示例

cURL

JavaScript

PHP

Python

---

Test user directory configuration

POST

/api/v1/user/directory/test

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"server": {

"name": "XCanLdap",

"directoryType": "OPENLDAP",

"host": "ldap.example.com",

"port": 389,

"ssl": false,

"username": "cn=admin,dc=example,dc=org",

"password": "admin"

},

"schema": {

"baseDn": "dc=example,dc=org",

"additionalUserDn": "ou=user",

"additionalGroupDn": "ou=group"

},

"userSchema": {

"objectClass": "posixAccount",

"objectFilter": "(objectclass=posixAccount)",

"usernameAttribute": "uid",

"firstNameAttribute": "givenName",

"lastNameAttribute": "sn",

"displayNameAttribute": "cn",

"emailAttribute": "mail",

"mobileAttribute": "mobile",

"passwordAttribute": "userPassword",

"passwordEncoderType": "string",

"ignoreSameIdentityUser": true

},

"groupSchema": {

"objectClass": "posixGroup",

"objectFilter": "(objectClass=posixGroup)",

"nameAttribute": "cn",

"descriptionAttribute": "string",

"ignoreSameNameGroup": true

},

"membershipSchema": {

"groupMemberAttribute": "memberUid",

"memberGroupAttribute": "gidNumber"

}

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/user/directory/test

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Update the sequence value and change the user directory synchronization order

PATCH

/api/v1/user/directory/reorder

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 0,

"sequence": 0

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/user/directory/reorder

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Enable or disable user directory

PATCH

/api/v1/user/directory/enabled

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 1,

"enabled": true

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/user/directory/enabled

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the detail of user directory

GET

/api/v1/user/directory/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Directory id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/user/directory/{id}

试验场

服务器

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Delete user directory

DELETE

/api/v1/user/directory/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Directory id

类型integer

必填

format"int64"

查询参数

deleteSync*

Delete synchronization data flag

类型boolean

必填

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/user/directory/{id}

试验场

服务器

授权

UserHttpBearer

变量

键

值

id*

deleteSync*

示例

cURL

JavaScript

PHP

Python

---