Users

Overview

User requests can be used to set and retrieve information for one or many Users. User requests support GET, PUT, POST and DELETE request types. For more about these request types and their uses see the Request Formats and Responses documentation.

Request and Responses

List of possible requests for Users.

Get User Names

Gets all the User names.

URL: http://hostname:portnumber/api/users?NamesOnly=true

Request Type: GET

Message Body: N/A

Response: JSON object containing all the User names.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Get Users

Gets all the User information for the provided User names.

URL: http://hostname:portnumber/api/users?Name=oneOrMoreValidUserNames

Request Type: GET

Message Body: N/A

Response: JSON object containing all the User information for the Users provided.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Get All Users

Gets all the Users.

URL: http://hostname:portnumber/api/users

Request Type: GET

Message Body: N/A

Response: JSON object containing all the User information for the Users provided.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Save User

Saves the User Information provided.

URL: http://hostname:portnumber/api/users

Request Type: PUT/POST

Message Body: JSON object containing all the User Information to save.

Response: “Success” for PUT, the User name and ID for POST.

Possible Errors:
  • 400 Bad Request:
    • No user information provided, or
    • No User name provided, or
    • User info already exists (POST error only).
  • 500 Internal Server Error: An exception occurred within the Deadline code.

Delete User

Deletes the Users corresponding to the User names provided.

URL: http://hostname:portnumber/api/users?Name=oneOrMoreValidUserNames

Request Type: DELETE

Message Body: N/A

Response: “Success”

Possible Errors:
  • 400 Bad Request:
    • No user information provided, or
    • No User names provided.
  • 500 Internal Server Error: An exception occurred within the Deadline code.

Get User Group Names

Gets all the User Group names.

URL: http://hostname:portnumber/api/usergroups

Request Type: GET

Message Body: N/A

Response: JSON object containing all the User Group names.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Get Users Names For User Group

Gets all the User names for the User Group that corresponds to the provided User Group name.

URL: http://hostname:portnumber/api/usergroups?Name=oneValidUserGroupName

Request Type: GET

Message Body: N/A

Response: JSON object containing all the User names in the User Group.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Get User Group Names For User

Gets all the User Group names for the User corresponding to the provided User name.

URL: http://hostname:portnumber/api/usergroups?User=onValidUserName

Request Type: GET

Message Body: N/A

Response: JSON object containing all the User Group names for the User.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Add Users To User Groups

Adds the Users corresponding to the User names provided to the User Groups corresponding with the User Group names provided.

URL: http://hostname:portnumber/api/usergroups

Request Type: PUT

Message Body:
JSON object where the following keys are mandatory:
  • Command = add
  • User = the user name/s to add (May be an Array)
  • Group = the user group name/s to add to (May be an Array)

Response: “Success”

Possible Errors:
  • 400 Bad Request: Missing one or more of the required keys in the JSON object in the message body.
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • Command key does not contain a valid command string, or
    • None of the provided User names correspond to real Users, or
    • None of the provided User Group names correspond to real User Groups.

Remove Users From User Groups

Removes the Users corresponding to the User names provided from the User Groups corresponding with the User Group names provided.

URL: http://hostname:portnumber/api/usergroups

Request Type: PUT

Message Body:
JSON object where the following keys are mandatory:
  • Command = remove
  • User = the user name/s to add (May be an Array)
  • Group = the user group name/s to add to (May be an Array)

Response: “Success”

Possible Errors:
  • 400 Bad Request: Missing one or more of the required keys in the JSON object in the message body.
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • Command key does not contain a valid command string, or
    • None of the provided User names correspond to real Users, or
    • None of the provided User Group names correspond to real User Groups.

Set Users For User Groups

Sets the Users corresponding to the User names provided for the User Groups corresponding with the User Group names provided.

URL: http://hostname:portnumber/api/usergroups

Request Type: PUT

Message Body:
JSON object where the following keys are mandatory:
  • Command = set
  • User = the user name/s to add (May be an Array)
  • Group = the user group name/s to add to (May be an Array)

Response: “Success”

Possible Errors:
  • 400 Bad Request: Missing one or more of the required keys in the JSON object in the message body.
  • 500 Internal Server Error:
    • An exception occurred within the Deadline code, or
    • Command key does not contain a valid command string, or
    • None of the provided User names correspond to real Users, or
    • None of the provided User Group names correspond to real User Groups.

Create New User Groups

Creates and saves new user groups with the given names.

URL: http://hostname:portnumber/api/usergroups

Request Type: POST

Message Body:

JSON object where the following keys are mandatory:
  • Group = the user group name/s to create (array)

Response: “Success”

Possible Errors:
  • 400 Bad Request: Missing one or more of the required keys in the JSON object in the message body.
  • 500 Internal Server Error: An exception occurred within the Deadline code

Delete User Groups

Deletes a user groups with the given name.

URL: http://hostname:portnumber/api/usergroups?Name=user+group+name+to+delete

Request Type: DELETE

Message Body: N/A

Response: “Success”

Possible Errors:
  • 400 Bad Request: Must provide a user group name to delete.
  • 500 Internal Server Error: An exception occurred within the Deadline code