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

Examples

GET /api/usergroups/1/external_usergroups
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "id": 1,
      "name": "external_usergroup5",
      "auth_source_ldap": {
        "id": 980190963,
        "type": "AuthSourceLdap",
        "name": "auth_source_ldap_6"
      }
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
usergroup_id
required

ID or name of user group

Validations:

  • Must be a 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

Examples

GET /api/usergroups/1/external_usergroups/1
200
{
  "id": 1,
  "name": "external_usergroup3",
  "auth_source_ldap": {
    "id": 980190963,
    "type": "AuthSourceLdap",
    "name": "auth_source_ldap_4"
  }
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
usergroup_id
required

ID or name of user group

Validations:

  • Must be a String
id
required

ID or name of external user group

Validations:

  • Must be a String
>>>

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

Examples

POST /api/usergroups/2-usergroup4/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_3"
  }
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
usergroup_id
required

ID or name of user group

Validations:

  • Must be a String
external_usergroup
required

External user group information

Validations:

  • Must be a Hash
external_usergroup[name]
required

External user group name

Validations:

  • Must be a 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

Examples

PUT /api/usergroups/1/external_usergroups/1
{
  "external_usergroup": {
    "name": "foremanusergroup"
  }
}
200
{
  "id": 1,
  "name": "foremanusergroup",
  "auth_source_ldap": {
    "id": 980190963,
    "type": "AuthSourceLdap",
    "name": "auth_source_ldap_5"
  }
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
usergroup_id
required

ID or name of user group

Validations:

  • Must be a String
id
required

ID or name of external user group

Validations:

  • Must be a String
external_usergroup
required

External user group information

Validations:

  • Must be a Hash
external_usergroup[name]
optional

External user group name

Validations:

  • Must be a 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

Examples

PUT /api/usergroups/1/external_usergroups/1/refresh
{
  "external_usergroup": {}
}
200
{
  "id": 1,
  "name": "external_usergroup6",
  "auth_source_id": 980190963,
  "usergroup_id": 1
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
usergroup_id
required

ID or name of user group

Validations:

  • Must be a String
id
required

ID or name of external user group

Validations:

  • Must be a String
>>>

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

Examples

DELETE /api/usergroups/1/external_usergroups/1
{
  "external_usergroup": {}
}
200
{
  "id": 1,
  "name": "external_usergroup1",
  "auth_source_id": 980190963,
  "usergroup_id": 1
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
usergroup_id
required

ID or name of user group

Validations:

  • Must be a String
id
required

ID or name external user group

Validations:

  • Must be a String