Create a user

put

/rest/ofscCore/v1/users/{login}

This operation creates a new user record or replaces an existing record. If a user with the specified login does not exist, then a new user record is created. If a user already exists, then the existing user properties are replaced with the properties specified in the request.

Consider the following conditions while creating a new user:

  • The user login has to be unique.
  • The user has to be assigned to one or more resources.
  • The other required fields such as 'name', 'userType', 'language', and 'timeZone' must be set.

Request

Path Parameters
  • The unique identifier of the user account in Oracle Field Service Cloud.
Body ()
Root Schema : userRequest
Type: object
Show Source
  • Title: Password
    The password of the user account. It is only used when the login policy is set to 'local password storage'. For SAML, the password is ignored.
Match All
Show Source
Nested Schema : User
Type: object
Title: User
The details of the user account.
Show Source
  • Title: Date Format
    The date format of the user account.
  • Title: Language
    The preferred language of the user. This field accepts the language codes listed on: Supported Language Codes.
  • Title: Long Date Format
    The long date format of the user account.
  • Title: Main Resource ID
    The unique identifier of the main resource of the user account. This field is only set for resources that represent field service personnel. It is not set for groups and routing buckets.

    This field is not returned in the response if empty strings are passed in the request.

  • Title: Name
    Minimum Length: 1
    The full name of the user.
  • Title: Organizational Unit
    The identifier of the organization unit where the user works. The value of this field can be the ID of a resource with the role as 'bucket' or 'organization unit'.
  • Title: Temporary Password
    The temporary password of the user account. If the temporary password is set, then the user is prompted to change password on the next login.
  • Resources
    Title: Resources
    Minimum Number of Items: 1
    Unique Items Required: true
    The list of resources assigned to the user account. These resources along with their children are visible to the user. This list does not incIude the resources whose resourceId values are empty.
  • Title: Self Assignment
    Indicates whether the users can assign activities to themselves.
  • Title: Status
    Allowed Values: [ "active", "inactive" ]
    The status of the user account.
  • Title: Time Format
    The time format of the user account.
  • Title: Time Zone
    The name of the user's time zone.

    This field accepts both OFSC time zone names (for example, Eastern) and IANA standard time zone names (for example, America/New_York). It is recommended that IANA names are specified.

    For a list of supported time zones, see Supported Time Zones.

  • Title: User Type
    Minimum Length: 1
    The type of the user account. The access controls of the user account are defined based on the user type.
  • Title: Week Start
    Allowed Values: [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "default" ]
    The day on which the week starts for the user account.
Nested Schema : Resources
Type: array
Title: Resources
Minimum Number of Items: 1
Unique Items Required: true
The list of resources assigned to the user account. These resources along with their children are visible to the user. This list does not incIude the resources whose resourceId values are empty.
Show Source
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : userResponse
Type: object
Show Source
Match All
Show Source
Nested Schema : Avatar
Type: object
Title: Avatar
The profile picture of the user.
Show Source
Nested Schema : User
Type: object
Title: User
The details of the user account.
Show Source
  • Title: Date Format
    The date format of the user account.
  • Title: Language
    The preferred language of the user. This field accepts the language codes listed on: Supported Language Codes.
  • Title: Long Date Format
    The long date format of the user account.
  • Title: Main Resource ID
    The unique identifier of the main resource of the user account. This field is only set for resources that represent field service personnel. It is not set for groups and routing buckets.

    This field is not returned in the response if empty strings are passed in the request.

  • Title: Name
    Minimum Length: 1
    The full name of the user.
  • Title: Organizational Unit
    The identifier of the organization unit where the user works. The value of this field can be the ID of a resource with the role as 'bucket' or 'organization unit'.
  • Title: Temporary Password
    The temporary password of the user account. If the temporary password is set, then the user is prompted to change password on the next login.
  • Resources
    Title: Resources
    Minimum Number of Items: 1
    Unique Items Required: true
    The list of resources assigned to the user account. These resources along with their children are visible to the user. This list does not incIude the resources whose resourceId values are empty.
  • Title: Self Assignment
    Indicates whether the users can assign activities to themselves.
  • Title: Status
    Allowed Values: [ "active", "inactive" ]
    The status of the user account.
  • Title: Time Format
    The time format of the user account.
  • Title: Time Zone
    The name of the user's time zone.

    This field accepts both OFSC time zone names (for example, Eastern) and IANA standard time zone names (for example, America/New_York). It is recommended that IANA names are specified.

    For a list of supported time zones, see Supported Time Zones.

  • Title: User Type
    Minimum Length: 1
    The type of the user account. The access controls of the user account are defined based on the user type.
  • Title: Week Start
    Allowed Values: [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "default" ]
    The day on which the week starts for the user account.
Nested Schema : Resources
Type: array
Title: Resources
Minimum Number of Items: 1
Unique Items Required: true
The list of resources assigned to the user account. These resources along with their children are visible to the user. This list does not incIude the resources whose resourceId values are empty.
Show Source

Default Response

This section describes the default error response for this operation.
Body ()
Root Schema : Error
Type: object
Error response
Show Source
Back to Top

Examples

The following example shows how to create a user by submitting a PUT request on the REST resource.

Example of Request Header

The following shows an example of the request header.

PUT /rest/ofscCore/v1/users/login HTTP/1.0
Authorization: Basic c29hcEB5YW1hdG86MQ==
Host: etadev1f
Accept: */*

Example of Request Body

The following shows an example of the request body.

{
  "name": "Test Name",
  "mainResourceId": "44042",
  "language": "en",
  "timeZone": "Arizona",
  "userType": "soap",
  "password": "123123123",
  "resources": ["44008", "44035"]
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx/1.6.2
Date: Fri, 24 Jul 2015 08:35:48 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "name": "Test Name",
  "status": "active",
  "login": "qwwqweqweqwe",
  "language": "en",
  "dateFormat": 12,
  "longDateFormat": 16,
  "timeFormat": 14,
  "timeZoneDiff": -420,
  "timeZone": "Arizona",
  "createdTime": "2015-09-01 08:20:18",
  "lastPasswordChangeTime": "2015-09-01 08:20:18",
  "userType": "soap",
  "resources":
        [
            "44008",
            "44035",
            "44042"
        ],
"collaborationGroups": 
     {
       "links": [
            {
              "rel": "canonical",
              "href": "https://etadev1f/rest/ofscCore/v1/users/qwwqweqweqwe/collaborationGroups"
            }
                ]
     },
        "links": [
            {
              "rel": "canonical",
              "href": "https://etadev1f/rest/ofscCore/v1/users/qwwqweqweqwe"
            },
            {
              "rel": "describedby",
              "href": "https://etadev1f/rest/ofscCore/v1/metadata-catalog/users"
            }
                 ]
}
Back to Top