Jump to

• Request
• Response
• Examples

Create a user account

post

/hcmRestApi/resources/11.13.18.05/userAccounts

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CredentialsEmailSentFlag: boolean
  Title: Credentials Email Sent

  Maximum Length: 30

  Default Value: false

  Indicates whether the user name and password credentials were sent to the user after the account was created. The default value is Yes. Valid values are Yes and No.
• GUID: string
  Title: GUID

  Maximum Length: 64

  Globally unique identifier for the user account.
• PersonId: integer (int64)
  Title: Person ID

  Unique identifier of the person record linked to the user account.
• PersonNumber: string
  Title: Person Number

  Maximum Length: 30

  Person number of the person record linked to the user account.
• SuspendedFlag: boolean
  Title: Suspended

  Maximum Length: 30

  Indicates whether the user, as part of termination, is suspended. If suspended, the user can be reactivated. Valid values are Yes and No.
• userAccountRoles: array User Account Roles
  Title: User Account Roles

  The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.
• UserId: integer (int64)
  Title: User ID

  Unique identifier for the user.
• Username: string
  Title: User Name

  Maximum Length: 100

  User name, a unique identifier for a user's account.

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number of the person record linked to the user account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SuspendedFlag":{
            "title":"Suspended",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the user, as part of termination, is suspended. If suspended, the user can be reactivated. Valid values are Yes and No.",
            "nullable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier of the person record linked to the user account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Username":{
            "title":"User Name",
            "maxLength":100,
            "type":"string",
            "description":"User name, a unique identifier for a user's account.",
            "nullable":true
        },
        "UserId":{
            "title":"User ID",
            "type":"integer",
            "description":"Unique identifier for the user.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "GUID":{
            "title":"GUID",
            "maxLength":64,
            "type":"string",
            "description":"Globally unique identifier for the user account.",
            "nullable":true
        },
        "CredentialsEmailSentFlag":{
            "title":"Credentials Email Sent",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the user name and password credentials were sent to the user after the account was created. The default value is Yes. Valid values are Yes and No.",
            "nullable":true,
            "default":false
        },
        "userAccountRoles":{
            "title":"User Account Roles",
            "type":"array",
            "description":"The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.",
            "items":{
                "$ref":"#/components/schemas/userAccounts-userAccountRoles-item-post-request"
            }
        }
    }
}

Nested Schema : User Account Roles

Type: array

Title: User Account Roles

The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.

Show Source

• Array of: object schema

{
    "title":"User Account Roles",
    "type":"array",
    "description":"The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.",
    "items":{
        "$ref":"#/components/schemas/userAccounts-userAccountRoles-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• RoleCode: string
  Title: Role Code

  Maximum Length: 240

  Technical name used to search for a specific role.
• RoleId: integer (int64)
  Title: Role ID

  Unique identifier of a role.
• UserRoleId: integer (int64)
  Title: User Role ID

  Unique identifier of the user role.

{
    "type":"object",
    "properties":{
        "UserRoleId":{
            "title":"User Role ID",
            "type":"integer",
            "description":"Unique identifier of the user role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RoleId":{
            "title":"Role ID",
            "type":"integer",
            "description":"Unique identifier of a role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RoleCode":{
            "title":"Role Code",
            "maxLength":240,
            "type":"string",
            "description":"Technical name used to search for a specific role.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : userAccounts-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the user account.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the user account was created.
• CredentialsEmailSentFlag: boolean
  Title: Credentials Email Sent

  Maximum Length: 30

  Default Value: false

  Indicates whether the user name and password credentials were sent to the user after the account was created. The default value is Yes. Valid values are Yes and No.
• GUID: string
  Title: GUID

  Maximum Length: 64

  Globally unique identifier for the user account.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the user account was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the user account.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: integer (int64)
  Title: Person ID

  Unique identifier of the person record linked to the user account.
• PersonNumber: string
  Title: Person Number

  Maximum Length: 30

  Person number of the person record linked to the user account.
• SuspendedFlag: boolean
  Title: Suspended

  Maximum Length: 30

  Indicates whether the user, as part of termination, is suspended. If suspended, the user can be reactivated. Valid values are Yes and No.
• userAccountRoles: array User Account Roles
  Title: User Account Roles

  The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.
• UserId: integer (int64)
  Title: User ID

  Unique identifier for the user.
• Username: string
  Title: User Name

  Maximum Length: 100

  User name, a unique identifier for a user's account.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the user account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number of the person record linked to the user account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user account was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the user account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GUID":{
            "title":"GUID",
            "maxLength":64,
            "type":"string",
            "description":"Globally unique identifier for the user account.",
            "nullable":true,
            "x-queryable":true
        },
        "userAccountRoles":{
            "title":"User Account Roles",
            "type":"array",
            "description":"The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.",
            "items":{
                "$ref":"#/components/schemas/userAccounts-userAccountRoles-item-response"
            }
        },
        "SuspendedFlag":{
            "title":"Suspended",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the user, as part of termination, is suspended. If suspended, the user can be reactivated. Valid values are Yes and No.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier of the person record linked to the user account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Username":{
            "title":"User Name",
            "maxLength":100,
            "type":"string",
            "description":"User name, a unique identifier for a user's account.",
            "nullable":true,
            "x-queryable":true
        },
        "UserId":{
            "title":"User ID",
            "type":"integer",
            "description":"Unique identifier for the user.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CredentialsEmailSentFlag":{
            "title":"Credentials Email Sent",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the user name and password credentials were sent to the user after the account was created. The default value is Yes. Valid values are Yes and No.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user account was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : User Account Roles

Type: array

Title: User Account Roles

The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.

Show Source

• Array of: object userAccounts-userAccountRoles-item-response

{
    "title":"User Account Roles",
    "type":"array",
    "description":"The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.",
    "items":{
        "$ref":"#/components/schemas/userAccounts-userAccountRoles-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : userAccounts-userAccountRoles-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the user account role assignment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the user account role assignment was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the user account role assignment was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the user account role assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RoleCode: string
  Title: Role Code

  Maximum Length: 240

  Technical name used to search for a specific role.
• RoleId: integer (int64)
  Title: Role ID

  Unique identifier of a role.
• UserRoleId: integer (int64)
  Title: User Role ID

  Unique identifier of the user role.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the user account role assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user account role assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the user account role assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserRoleId":{
            "title":"User Role ID",
            "type":"integer",
            "description":"Unique identifier of the user role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RoleId":{
            "title":"Role ID",
            "type":"integer",
            "description":"Unique identifier of a role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RoleCode":{
            "title":"Role Code",
            "maxLength":240,
            "type":"string",
            "description":"Technical name used to search for a specific role.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user account role assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

autoprovisionRoles

Operation: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/action/autoprovisionRoles

Parameters:

• GUID: $request.path.GUID

Triggers the roles autoprovisioning process on the selected user account.

resetPassword

Operation: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/action/resetPassword

Parameters:

• GUID: $request.path.GUID

Resets the password to a user account. Initiating this custom action on the selected user account must trigger the password reset flow.

updatePassword

Operation: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/action/updatePassword

Parameters:

• GUID: $request.path.GUID

Updates the password to a user account. Initiating the custom action on the selected user account must trigger the password update flow.

userAccountRoles

Operation: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/child/userAccountRoles

Parameters:

• GUID: $request.path.GUID

The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.

Back to Top

Examples

The following example shows how to create a user account by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/userAccounts"

Example of Payload

The following is an example of the payload.

{
  "PersonId": 300100182158891
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 201 Created
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

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

{
  "UserId" : 300100185541354,
  "Username" : "[e-mail]",
  "SuspendedFlag" : false,
  "PersonId" : 300100182158891,
  "PersonNumber" : "955160008191624",
  "CredentialsEmailSentFlag" : false,
  "GUID" : "8A8D68E5E062BAFCE050F50A9C4E9A63",
  "CreatedBy" : "HR_SPEC_ALL",
  "CreationDate" : "2019-06-10T19:31:32+00:00",
  "LastUpdatedBy" : "HR_SPEC_ALL",
  "LastUpdateDate" : "2019-06-10T19:31:33.452+00:00",
  "links": [
      {
        ...}
  	]
}

Back to Top