POST /user-groups
Bearer auth

This API call is used to create a new user group.

Name Collisions

If you try to create a user group with a name that is already associated with another user group, the operation will fail and return an HTTP status code 400 (Bad Request).

application/json

Body Required

  • name string

    Name of user group.

  • description string

    Description of user group.

  • userGroupType string

    Values are Reconciler User Group, Reviewer User Group, JE Preparer User Group, or JE Security User Group.

  • locationId string

    The location code value.

  • departmentId string

    The department code value.

  • defaultUser string

    Username of default user of user group.

  • users array[string]

    List of usernames to add to user group.

Responses

  • 200 application/json

    Success Response

    Hide response attributes Show response attributes object
    • id integer

      Unique identifier of user group

    • name string

      Name of user group.

    • status string

      Status of user group processing.

    • message string

      Status message of user group processing.
  • 400 application/json

    Failed Response

    Hide response attributes Show response attributes object
    • id integer

      Unique identifier of user group

    • name string

      Name of user group.

    • status string

      Status of user group processing.

    • message string

      Status message of user group processing.
  • 401 application/json

    Authentication Error. Invalid credentials.

    Hide response attributes Show response attributes object
    • code string
    • message string
    • description string
  • 403

    Authorization Error. Invalid role for request.

POST /user-groups 
curl \
 --request POST 'https://localhost:8080/user-groups' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"Rec Reviewers","description":"Rec Reviewers","userGroupType":"Reviewer User Group","locationId":"APAC","departmentId":"AA","defaultUser":"javarro","users":["javarro","bribbon","tsanchez"]}'
Request example 
{
  "name": "Rec Reviewers",
  "description": "Rec Reviewers",
  "userGroupType": "Reviewer User Group",
  "locationId": "APAC",
  "departmentId": "AA",
  "defaultUser": "javarro",
  "users": [
    "javarro",
    "bribbon",
    "tsanchez"
  ]
}
Response examples (200) 
{
  "id": 12,
  "name": "Rec Reviewers",
  "status": "Success",
  "message": "User group created successfully."
}
Response examples (400) 
{
  "status": "Failure",
  "messages": [
    "Name already exists.",
    "Invalid value for DepartmentId. Allowable values: AA."
  ]
}
Response examples (401) 
{
  "code": "900901",
  "message": "Invalid Credentials",
  "description": "Access failure for API: /api/admin/v1.1.0, version: v1.1.0 status: (900901) - Invalid Credentials. Make sure you have provided the correct security credentials"
}