GET /api/usergroups/:usergroup_id/external_usergroups
List all external user groups for user group

GET /api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups
List all external user groups for LDAP authentication source

Params

Param Name Description
usergroup_id
Required

ID or name of user group


Value: Must be String

GET /api/usergroups/:usergroup_id/external_usergroups/:id
Show an external user group for user group

GET /api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id
Show an external user group for LDAP authentication source

Params

Param Name Description
usergroup_id
Required

ID or name of user group


Value: Must be String
id
Required

ID or name of external user group


Value: Must be String

POST /api/usergroups/:usergroup_id/external_usergroups
Create an external user group linked to a user group

Params

Param Name Description
usergroup_id
Required

ID or name of user group


Value: Must be String
external_usergroup
Required

External user group information


Value: Must be a Hash
external_usergroup[name]
Required

External user group name


Value: Must be String
external_usergroup[auth_source_id]
Required

ID of linked authentication source


Value: Must be Fixnum

PUT /api/usergroups/:usergroup_id/external_usergroups/:id
Update external user group

Params

Param Name Description
usergroup_id
Required

ID or name of user group


Value: Must be String
id
Required

ID or name of external user group


Value: Must be String
external_usergroup
Required

External user group information


Value: Must be a Hash
external_usergroup[name]
Optional

External user group name


Value: Must be String
external_usergroup[auth_source_id]
Optional

ID of linked authentication source


Value: Must be Fixnum

PUT /api/usergroups/:usergroup_id/external_usergroups/:id/refresh
刷新外部使用者群組

Params

Param Name Description
usergroup_id
Required

ID or name of user group


Value: Must be String
id
Required

ID or name of external user group


Value: Must be String

DELETE /api/usergroups/:usergroup_id/external_usergroups/:id
Delete an external user group

Params

Param Name Description
usergroup_id
Required

ID or name of user group


Value: Must be String
id
Required

ID or name external user group


Value: Must be String