External usergroups

>>>

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
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
usergroup_id
required

ID or name of user group

Validations:

  • 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
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
usergroup_id
required

ID or name of user group

Validations:

  • String
id
required

ID or name of external user group

Validations:

  • String
>>>

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
usergroup_id
required

ID or name of user group

Validations:

  • String
external_usergroup
required

External user group information

Validations:

  • Hash
external_usergroup[name]
required

External user group name

Validations:

  • String
external_usergroup[auth_source_id]
required

ID of linked authentication source

Validations:

  • Must be a number.
>>>

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
usergroup_id
required

ID or name of user group

Validations:

  • String
id
required

ID or name of external user group

Validations:

  • String
external_usergroup
required

External user group information

Validations:

  • Hash
external_usergroup[name]
optional

External user group name

Validations:

  • String
external_usergroup[auth_source_id]
optional

ID of linked authentication source

Validations:

  • Must be a number.
>>>

PUT /api/usergroups/:usergroup_id/external_usergroups/:id/refresh
Refresh external user group

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
usergroup_id
required

ID or name of user group

Validations:

  • String
id
required

ID or name of external user group

Validations:

  • String
>>>

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
usergroup_id
required

ID or name of user group

Validations:

  • String
id
required

ID or name external user group

Validations:

  • String