GET /api/usergroups/6/external_usergroups 200 { "total": 1, "subtotal": 1, "page": 1, "per_page": 20, "search": null, "sort": { "by": null, "order": null }, "results": [ { "id": 6, "name": "external_usergroup10", "auth_source_ldap": { "id": 980190968, "type": "AuthSourceLdap", "name": "auth_source_ldap_44" } } ] }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
usergroup_id required |
ID or name of user group Validations:
|
GET /api/usergroups/5/external_usergroups/5 200 { "id": 5, "name": "external_usergroup9", "auth_source_ldap": { "id": 980190967, "type": "AuthSourceLdap", "name": "auth_source_ldap_43" } }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
usergroup_id required |
ID or name of user group Validations:
|
id required |
ID or name of external user group Validations:
|
POST /api/usergroups/2-usergroup143/external_usergroups { "external_usergroup": { "name": "foremanusergroup", "auth_source_id": 980190964 } } 201 { "id": 2, "name": "foremanusergroup", "auth_source_ldap": { "id": 980190964, "type": "AuthSourceLdap", "name": "auth_source_ldap_40" } }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
usergroup_id required |
ID or name of user group Validations:
|
external_usergroup required |
External user group information Validations:
|
external_usergroup[name] required |
External user group name Validations:
|
external_usergroup[auth_source_id] required |
ID of linked authentication source Validations:
|
PUT /api/usergroups/7/external_usergroups/7 { "external_usergroup": { "name": "foremanusergroup" } } 200 { "id": 7, "name": "foremanusergroup", "auth_source_ldap": { "id": 980190969, "type": "AuthSourceLdap", "name": "auth_source_ldap_45" } }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
usergroup_id required |
ID or name of user group Validations:
|
id required |
ID or name of external user group Validations:
|
external_usergroup required |
External user group information Validations:
|
external_usergroup[name] optional |
External user group name Validations:
|
external_usergroup[auth_source_id] optional |
ID of linked authentication source Validations:
|
PUT /api/usergroups/3/external_usergroups/3/refresh { "external_usergroup": {} } 200 { "id": 3, "name": "external_usergroup7", "auth_source_id": 980190965, "usergroup_id": 3 }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
usergroup_id required |
ID or name of user group Validations:
|
id required |
ID or name of external user group Validations:
|
DELETE /api/usergroups/4/external_usergroups/4 { "external_usergroup": {} } 200 { "id": 4, "name": "external_usergroup8", "auth_source_id": 980190966, "usergroup_id": 4 }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
usergroup_id required |
ID or name of user group Validations:
|
id required |
ID or name external user group Validations:
|