Jump to

• Request
• Response
• Examples

Create Users

post

/rest/v19/users

Create a new user.

Request

Supported Media Types

• application/json

Body ()

Root Schema : user-request

Type: object

Show Source

• accessPermissions: object Access Permissions
  Title: Access Permissions

  Access Permissions of the user
• approvalDelegate: string
  Title: Approval Delegate

  Approval Delegate
• billAddress1: string
  Title: Billing Address 1

  Billing Address 1
• billAddress2: string
  Title: Billing Address 2

  Billing Address 2
• billCity: string
  Title: Billing City

  Billing City
• billCompany: string
  Title: Billing Company

  Billing Company
• billCompany2: string
  Title: Billing Company 2

  Billing Company 2
• billCountry: string
  Title: Billing Country

  Billing Country
• billEmail: string
  Title: Billing Email

  Billing Email
• billFax: string
  Title: Billing Fax

  Billing Fax
• billFirstName: string
  Title: Billing First Name

  Billing First Name
• billLastName: string
  Title: Billing Last Name

  Billing Last Name
• billPhone: string
  Title: Billing Phone

  Billing Phone
• billStateProvince: string
  Title: Billing State

  Billing State
• billZip: string
  Title: Billing Zip

  Billing Zip
• currency: object Currency
  Title: Currency

  Currency preference of user. Value holds currency code
• dateFormat: object Date Format
  Title: Date Format

  User preferred date time format
• email: string
  Title: Email

  Email of the user
• emailPassword: boolean
  Title: Should email password?

  Send an email containing the password to the email address specified in the email field.
• enabledForSso: object Enabled For SSO
  Title: Enabled For SSO

  Enabled For SSO
• externalSsoId: string
  Title: External SSO Id

  External SSO Id
• fax: string
  Title: Fax Number

  Fax of the user
• firstName: string
  Title: First Name

  First Name of the user
• groups: object Groups
  Title: Groups

  Groups to which the user belongs
• isAccessAdminPermEnabled: boolean
  Title: Access Admin Permission Enabled

  Access Admin Permission Enabled
• isApplicationAdminPermEnabled: boolean
  Title: Application Administrator

  Indicates whether user is an Application Administrator.
• isMobileEnabled: boolean
  Title: Is Mobile Enabled

  Is Mobile Enabled
• isNotifyEmail: boolean
  Title: Is Notification Preference Email

  Is notification preference email
• isNotifyFax: boolean
  Title: Is Notification Preference Fax

  Is notification preference fax
• isProxyPermEnabled: boolean
  Title: Proxy Permission Enabled

  Proxy permission enabled
• isUserAdminPermEnabled: boolean
  Title: Is User Admin Permission Enabled

  Is User Admin Permission Enabled
• isWebServicesOnly: boolean
  Title: Web Services Only

  Web Services Only
• jobTitle: string
  Title: Job Title

  Job Title of the user
• language: object Language
  Title: Language

  Language preference of user. Value holds language code
• lastName: string
  Title: Last Name

  Last Name of the user
• login: string
  Title: Login Id

  Login Id of the user
• numberFormat: object Number Format
  Title: Number Format

  Preferred number format of user
• oauthClientId: string
  Title: OAuth Client Id

  Client Id of the OAuth client that has a 1-to-1 association with the user
• partnerLogin: string
  Title: Partner Login

  Partner Login
• password: string
  Title: Password

  The password that the user will use to log in to the site.
• phone: string
  Title: Phone Number

  Phone number of the user
• separateShipAddr: boolean
  Title: Seperate Ship Address

  Seperate Ship Address
• sfdcOrgId: string
  Title: SFDC Organization ID

  SFDC Organization ID
• shipAddress1: string
  Title: Shipping Address 1

  Shipping Address 1
• shipAddress2: string
  Title: Shipping Address 2

  Shipping Address 2
• shipCity: string
  Title: Shipping City

  Shipping City
• shipCompany: string
  Title: Shipping Company

  Shipping Company
• shipCompany2: string
  Title: Shipping Company 2

  Shipping Company 2
• shipCountry: string
  Title: Shipping Country

  Shipping Country
• shipEmail: string
  Title: Shipping Email

  Shipping Email
• shipFax: string
  Title: Shipping Fax

  Shipping Fax
• shipFirstName: string
  Title: Shipping First Name

  Shipping First Name
• shipLastName: string
  Title: Shipping Last Name

  Shipping Last Name
• shipPhone: string
  Title: Shipping Phone

  Shipping Phone
• shipStateProvince: string
  Title: Shipping State

  Shipping State
• shipZip: string
  Title: Shipping Zip

  Shipping Zip
• status: object Status
  Title: Status

  Status of the user
• timeZone: object TimeZone of user
  Title: TimeZone of user

  User preferred timezone
• type: object Type
  Title: Type

  Type of the user
• units: object Units
  Title: Units

  User preferred units

{
    "type":"object",
    "properties":{
        "login":{
            "type":"string",
            "description":"Login Id of the user",
            "title":"Login Id"
        },
        "firstName":{
            "type":"string",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "jobTitle":{
            "type":"string",
            "description":"Job Title of the user",
            "title":"Job Title"
        },
        "email":{
            "type":"string",
            "description":"Email of the user",
            "title":"Email"
        },
        "phone":{
            "type":"string",
            "description":"Phone number of the user",
            "title":"Phone Number"
        },
        "fax":{
            "type":"string",
            "description":"Fax of the user",
            "title":"Fax Number"
        },
        "billFirstName":{
            "type":"string",
            "description":"Billing First Name",
            "title":"Billing First Name"
        },
        "billLastName":{
            "type":"string",
            "description":"Billing Last Name",
            "title":"Billing Last Name"
        },
        "billCompany":{
            "type":"string",
            "description":"Billing Company",
            "title":"Billing Company"
        },
        "billCompany2":{
            "type":"string",
            "description":"Billing Company 2",
            "title":"Billing Company 2"
        },
        "billAddress1":{
            "type":"string",
            "description":"Billing Address 1",
            "title":"Billing Address 1"
        },
        "billAddress2":{
            "type":"string",
            "description":"Billing Address 2",
            "title":"Billing Address 2"
        },
        "billCity":{
            "type":"string",
            "description":"Billing City",
            "title":"Billing City"
        },
        "billStateProvince":{
            "type":"string",
            "description":"Billing State",
            "title":"Billing State"
        },
        "billZip":{
            "type":"string",
            "description":"Billing Zip",
            "title":"Billing Zip"
        },
        "billCountry":{
            "type":"string",
            "description":"Billing Country",
            "title":"Billing Country"
        },
        "billPhone":{
            "type":"string",
            "description":"Billing Phone",
            "title":"Billing Phone"
        },
        "billFax":{
            "type":"string",
            "description":"Billing Fax",
            "title":"Billing Fax"
        },
        "billEmail":{
            "type":"string",
            "description":"Billing Email",
            "title":"Billing Email"
        },
        "shipFirstName":{
            "type":"string",
            "description":"Shipping First Name",
            "title":"Shipping First Name"
        },
        "shipLastName":{
            "type":"string",
            "description":"Shipping Last Name",
            "title":"Shipping Last Name"
        },
        "shipCompany":{
            "type":"string",
            "description":"Shipping Company",
            "title":"Shipping Company"
        },
        "shipCompany2":{
            "type":"string",
            "description":"Shipping Company 2",
            "title":"Shipping Company 2"
        },
        "shipAddress1":{
            "type":"string",
            "description":"Shipping Address 1",
            "title":"Shipping Address 1"
        },
        "shipAddress2":{
            "type":"string",
            "description":"Shipping Address 2",
            "title":"Shipping Address 2"
        },
        "shipCity":{
            "type":"string",
            "description":"Shipping City",
            "title":"Shipping City"
        },
        "shipStateProvince":{
            "type":"string",
            "description":"Shipping State",
            "title":"Shipping State"
        },
        "shipZip":{
            "type":"string",
            "description":"Shipping Zip",
            "title":"Shipping Zip"
        },
        "shipCountry":{
            "type":"string",
            "description":"Shipping Country",
            "title":"Shipping Country"
        },
        "shipPhone":{
            "type":"string",
            "description":"Shipping Phone",
            "title":"Shipping Phone"
        },
        "shipFax":{
            "type":"string",
            "description":"Shipping Fax",
            "title":"Shipping Fax"
        },
        "shipEmail":{
            "type":"string",
            "description":"Shipping Email",
            "title":"Shipping Email"
        },
        "externalSsoId":{
            "type":"string",
            "description":"External SSO Id",
            "title":"External SSO Id"
        },
        "approvalDelegate":{
            "type":"string",
            "description":"Approval Delegate",
            "title":"Approval Delegate"
        },
        "separateShipAddr":{
            "type":"boolean",
            "description":"Seperate Ship Address",
            "title":"Seperate Ship Address"
        },
        "partnerLogin":{
            "type":"string",
            "description":"Partner Login",
            "title":"Partner Login"
        },
        "sfdcOrgId":{
            "type":"string",
            "description":"SFDC Organization ID",
            "title":"SFDC Organization ID"
        },
        "isNotifyEmail":{
            "type":"boolean",
            "description":"Is notification preference email",
            "title":"Is Notification Preference Email"
        },
        "isNotifyFax":{
            "type":"boolean",
            "description":"Is notification preference fax",
            "title":"Is Notification Preference Fax"
        },
        "isUserAdminPermEnabled":{
            "type":"boolean",
            "description":"Is User Admin Permission Enabled",
            "title":"Is User Admin Permission Enabled"
        },
        "isWebServicesOnly":{
            "type":"boolean",
            "description":"Web Services Only",
            "title":"Web Services Only"
        },
        "isApplicationAdminPermEnabled":{
            "type":"boolean",
            "description":"Indicates whether user is an Application Administrator.",
            "title":"Application Administrator"
        },
        "type":{
            "type":"object",
            "description":"Type of the user",
            "title":"Type",
            "properties":{
                "value":{
                    "$ref":"#/definitions/value"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "language":{
            "type":"object",
            "description":"Language preference of user. Value holds language code",
            "title":"Language",
            "properties":{
                "value":{
                    "$ref":"#/definitions/value"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "currency":{
            "type":"object",
            "description":"Currency preference of user. Value holds currency code",
            "title":"Currency",
            "properties":{
                "value":{
                    "$ref":"#/definitions/value"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "numberFormat":{
            "type":"object",
            "description":"Preferred number format of user",
            "title":"Number Format",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "timeZone":{
            "type":"object",
            "description":"User preferred timezone",
            "title":"TimeZone of user",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "units":{
            "type":"object",
            "description":"User preferred units",
            "title":"Units",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "dateFormat":{
            "type":"object",
            "description":"User preferred date time format",
            "title":"Date Format",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "status":{
            "type":"object",
            "description":"Status of the user",
            "title":"Status",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "enabledForSso":{
            "type":"object",
            "description":"Enabled For SSO",
            "title":"Enabled For SSO",
            "properties":{
                "value":{
                    "$ref":"#/definitions/value"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "isMobileEnabled":{
            "type":"boolean",
            "description":"Is Mobile Enabled",
            "title":"Is Mobile Enabled"
        },
        "isAccessAdminPermEnabled":{
            "type":"boolean",
            "description":"Access Admin Permission Enabled",
            "title":"Access Admin Permission Enabled"
        },
        "isProxyPermEnabled":{
            "type":"boolean",
            "description":"Proxy permission enabled",
            "title":"Proxy Permission Enabled"
        },
        "password":{
            "type":"string",
            "description":"The password that the user will use to log in to the site.",
            "title":"Password"
        },
        "emailPassword":{
            "type":"boolean",
            "description":"Send an email containing the password to the email address specified in the email field.",
            "title":"Should email password?"
        },
        "groups":{
            "type":"object",
            "description":"Groups to which the user belongs",
            "title":"Groups",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/group"
                    }
                }
            }
        },
        "accessPermissions":{
            "type":"object",
            "description":"Access Permissions of the user",
            "title":"Access Permissions",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/accessPermission"
                    }
                }
            }
        },
        "oauthClientId":{
            "type":"string",
            "description":"Client Id of the OAuth client that has a 1-to-1 association with the user",
            "title":"OAuth Client Id"
        }
    }
}

Nested Schema : Access Permissions

Type: object

Title: Access Permissions

Access Permissions of the user

Show Source

• items: array items

{
    "type":"object",
    "description":"Access Permissions of the user",
    "title":"Access Permissions",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/accessPermission"
            }
        }
    }
}

Nested Schema : Currency

Type: object

Title: Currency

Currency preference of user. Value holds currency code

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: string
  Title: Value

  Value

{
    "type":"object",
    "description":"Currency preference of user. Value holds currency code",
    "title":"Currency",
    "properties":{
        "value":{
            "$ref":"#/definitions/value"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Date Format

Type: object

Title: Date Format

User preferred date time format

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value.

{
    "type":"object",
    "description":"User preferred date time format",
    "title":"Date Format",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Enabled For SSO

Type: object

Title: Enabled For SSO

Enabled For SSO

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: string
  Title: Value

  Value

{
    "type":"object",
    "description":"Enabled For SSO",
    "title":"Enabled For SSO",
    "properties":{
        "value":{
            "$ref":"#/definitions/value"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Groups

Type: object

Title: Groups

Groups to which the user belongs

Show Source

• items: array items

{
    "type":"object",
    "description":"Groups to which the user belongs",
    "title":"Groups",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/group"
            }
        }
    }
}

Nested Schema : Language

Type: object

Title: Language

Language preference of user. Value holds language code

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: string
  Title: Value

  Value

{
    "type":"object",
    "description":"Language preference of user. Value holds language code",
    "title":"Language",
    "properties":{
        "value":{
            "$ref":"#/definitions/value"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Number Format

Type: object

Title: Number Format

Preferred number format of user

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value.

{
    "type":"object",
    "description":"Preferred number format of user",
    "title":"Number Format",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Status

Type: object

Title: Status

Status of the user

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value.

{
    "type":"object",
    "description":"Status of the user",
    "title":"Status",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : TimeZone of user

Type: object

Title: TimeZone of user

User preferred timezone

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value.

{
    "type":"object",
    "description":"User preferred timezone",
    "title":"TimeZone of user",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Type

Type: object

Title: Type

Type of the user

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: string
  Title: Value

  Value

{
    "type":"object",
    "description":"Type of the user",
    "title":"Type",
    "properties":{
        "value":{
            "$ref":"#/definitions/value"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Units

Type: object

Title: Units

User preferred units

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value.

{
    "type":"object",
    "description":"User preferred units",
    "title":"Units",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Access Permission
  Title: Access Permission

  User access bits information

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/accessPermission"
    }
}

Nested Schema : Access Permission

Type: object

Title: Access Permission

User access bits information

Show Source

• hasAccess: boolean
  Title: Has Access

  Flag to determine if user has access to the restricted entity
• name: string
  Title: Restricted Entity Name

  Name of the entity to which access restrictions apply
• type: string
  Title: Type

  Type of the restricted entity. Possible values productFamily, supportedProductFamily and dataTableFolder
• variableName: string
  Title: Restricted Entity Variable Name

  Variable name of the entity to which access restrictions apply

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the entity to which access restrictions apply",
            "title":"Restricted Entity Name"
        },
        "variableName":{
            "type":"string",
            "description":"Variable name of the entity to which access restrictions apply",
            "title":"Restricted Entity Variable Name"
        },
        "hasAccess":{
            "type":"boolean",
            "description":"Flag to determine if user has access to the restricted entity",
            "title":"Has Access"
        },
        "type":{
            "type":"string",
            "description":"Type of the restricted entity. Possible values productFamily, supportedProductFamily and dataTableFolder",
            "title":"Type"
        }
    },
    "title":"Access Permission",
    "description":"User access bits information"
}

Nested Schema : items

Type: array

Show Source

• Array of: object Group Details
  Title: Group Details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/group"
    }
}

Nested Schema : Group Details

Type: object

Title: Group Details

Show Source

• company: object Company Details
  Title: Company Details

  Company details to which the group belongs.
• description: string
  Title: Description

  Description of the group.
• label: string
  Title: Label

  Label of the group.
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects
• readOnly: boolean
  Title: ReadOnly

  Is read only group?
• segments: object Segments
  Title: Segments

  Access Segments for a group
• status: object Status
  Title: Status

  Status of the group.
• type: object Type
  Title: Type

  Type of the group.
• users: object Users
  Title: Users

  All users of a group
• variableName: string
  Title: VariableName

  Group variable name.

{
    "type":"object",
    "properties":{
        "readOnly":{
            "type":"boolean",
            "description":"Is read only group?",
            "title":"ReadOnly"
        },
        "label":{
            "type":"string",
            "description":"Label of the group.",
            "title":"Label"
        },
        "variableName":{
            "type":"string",
            "description":"Group variable name.",
            "title":"VariableName"
        },
        "description":{
            "type":"string",
            "description":"Description of the group.",
            "title":"Description"
        },
        "status":{
            "type":"object",
            "description":"Status of the group.",
            "title":"Status",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "type":{
            "type":"object",
            "description":"Type of the group.",
            "title":"Type",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "company":{
            "$ref":"#/definitions/group-company-props"
        },
        "users":{
            "$ref":"#/definitions/user-collection"
        },
        "segments":{
            "$ref":"#/definitions/accessSegments-collection"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Group Details"
}

Nested Schema : Company Details

Type: object

Title: Company Details

Company details to which the group belongs.

Show Source

• loginName: string
  Title: Company Login Name

  Company login name.
• name: string
  Title: Company Name

  Company name.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Company name.",
            "title":"Company Name"
        },
        "loginName":{
            "type":"string",
            "description":"Company login name.",
            "title":"Company Login Name"
        }
    },
    "title":"Company Details",
    "description":"Company details to which the group belongs."
}

Nested Schema : Links to the related objects

Type: array

Title: Links to the related objects

Links to the related objects

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects",
    "title":"Links to the related objects",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : Segments

Type: object

Title: Segments

Access Segments for a group

Show Source

• items: array items
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/accessSegments"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Segments",
    "description":"Access Segments for a group"
}

Nested Schema : Status

Type: object

Title: Status

Status of the group.

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value.

{
    "type":"object",
    "description":"Status of the group.",
    "title":"Status",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Type

Type: object

Title: Type

Type of the group.

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value.

{
    "type":"object",
    "description":"Type of the group.",
    "title":"Type",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Users

Type: object

Title: Users

All users of a group

Show Source

• items: array items
• links: array Links
  Title: Links

  Links to the related objects.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/user"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Users",
    "description":"All users of a group"
}

Nested Schema : reference links

Type: object

Title: reference links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: URL to the related object

  URL to the related object
• name: string
• rel: string
  Title: Link Relationship to the current object

  Default Value: self

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object",
            "default":"self"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        },
        "name":{
            "type":"string"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Nested Schema : items

Type: array

Show Source

• Array of: object Segment Details
  Title: Segment Details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/accessSegments"
    }
}

Nested Schema : Links to the related objects

Type: array

Title: Links to the related objects

Links to the related objects

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects",
    "title":"Links to the related objects",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : Segment Details

Type: object

Title: Segment Details

Show Source

• checked: boolean
  Title: Checked

  Is segment enabled.
• icon: string
  Title: Icon

  Path of the icon image file. This field is only applicable if uiMetadata is set as true.
• segments: object Sub Segments
  Title: Sub Segments

  Sub access segments for the segment.
• status: integer
  Title: Status

  Specifies if the segment is enabled, partially selected or unselected. Possible values are 0[UNCHECKED], 1[PARTIALCHECKED],2[CHECKED]. This field is only applicable if uiMetadata is set as true.
• variableName(required): string
  Title: VariableName

  Segment variable name.

{
    "type":"object",
    "required":[
        "variableName"
    ],
    "properties":{
        "variableName":{
            "type":"string",
            "description":"Segment variable name.",
            "title":"VariableName"
        },
        "checked":{
            "type":"boolean",
            "description":"Is segment enabled.",
            "title":"Checked"
        },
        "icon":{
            "type":"string",
            "description":"Path of the icon image file. This field is only applicable if uiMetadata is set as true.",
            "title":"Icon"
        },
        "status":{
            "type":"integer",
            "description":"Specifies if the segment is enabled, partially selected or unselected. Possible values are 0[UNCHECKED], 1[PARTIALCHECKED],2[CHECKED]. This field is only applicable if uiMetadata is set as true.",
            "title":"Status"
        },
        "segments":{
            "type":"object",
            "description":"Sub access segments for the segment.",
            "title":"Sub Segments",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/subSegmentAccess"
                    }
                }
            }
        }
    },
    "title":"Segment Details"
}

Nested Schema : Sub Segments

Type: object

Title: Sub Segments

Sub access segments for the segment.

Show Source

• items: array items

{
    "type":"object",
    "description":"Sub access segments for the segment.",
    "title":"Sub Segments",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/subSegmentAccess"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Sub Segment Details
  Title: Sub Segment Details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/subSegmentAccess"
    }
}

Nested Schema : Sub Segment Details

Type: object

Title: Sub Segment Details

Show Source

• checked: boolean
  Title: Checked

  Is segment enabled.
• icon: string
  Title: Icon

  Path of the icon image file. This field is only applicable if uiMetadata is set as true.
• status: integer
  Title: Status

  Specifies if the segment is enabled, partially selected or unselected. Possible values are 0[UNCHECKED], 1[PARTIALCHECKED],2[CHECKED]. This field is only applicable if uiMetadata is set as true.
• title: string
  Title: title

  Segment label.
• variableName(required): string
  Title: VariableName

  Segment variable name.

{
    "type":"object",
    "required":[
        "variableName"
    ],
    "properties":{
        "title":{
            "type":"string",
            "description":"Segment label.",
            "title":"title"
        },
        "variableName":{
            "type":"string",
            "description":"Segment variable name.",
            "title":"VariableName"
        },
        "checked":{
            "type":"boolean",
            "description":"Is segment enabled.",
            "title":"Checked"
        },
        "icon":{
            "type":"string",
            "description":"Path of the icon image file. This field is only applicable if uiMetadata is set as true.",
            "title":"Icon"
        },
        "status":{
            "type":"integer",
            "description":"Specifies if the segment is enabled, partially selected or unselected. Possible values are 0[UNCHECKED], 1[PARTIALCHECKED],2[CHECKED]. This field is only applicable if uiMetadata is set as true.",
            "title":"Status"
        }
    },
    "title":"Sub Segment Details"
}

Nested Schema : items

Type: array

Show Source

• Array of: object User Details
  Title: User Details

  User details of group.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/user"
    }
}

Nested Schema : Links

Type: array

Title: Links

Links to the related objects.

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : User Details

Type: object

Title: User Details

User details of group.

Show Source

• firstName: string
  Title: User First Name

  First name of the user.
• lastName: string
  Title: User Last Name

  Last name of the user.
• login: string
  Title: User Login Id

  Login Id of the user.

{
    "type":"object",
    "properties":{
        "login":{
            "type":"string",
            "description":"Login Id of the user.",
            "title":"User Login Id"
        },
        "firstName":{
            "type":"string",
            "description":"First name of the user.",
            "title":"User First Name"
        },
        "lastName":{
            "type":"string",
            "description":"Last name of the user.",
            "title":"User Last Name"
        }
    },
    "title":"User Details",
    "description":"User details of group."
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Created User details

Body ()

Root Schema : User Details

Type: object

Title: User Details

User details of group.

Show Source

• firstName: string
  Title: User First Name

  First name of the user.
• lastName: string
  Title: User Last Name

  Last name of the user.
• login: string
  Title: User Login Id

  Login Id of the user.

{
    "type":"object",
    "properties":{
        "login":{
            "type":"string",
            "description":"Login Id of the user.",
            "title":"User Login Id"
        },
        "firstName":{
            "type":"string",
            "description":"First name of the user.",
            "title":"User First Name"
        },
        "lastName":{
            "type":"string",
            "description":"Last name of the user.",
            "title":"User Last Name"
        }
    },
    "title":"User Details",
    "description":"User details of group."
}

Back to Top

Examples

The following example shows how to create new users by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/users

Request Body Sample

{
    "login": "simon.watts",
    "firstName": "Simon",
    "jobTitle": "Sales Manager Administrator",
    "email": "[e-mail]",
    "phone": "2346456456",
    "fax": "456457657",
    "billLastName": "Watts",
    "billCompany": "abc",
    "billCompany2": "jkl",
    "billAddress1": "Address",
    "billAddress2": "Address",
    "billCity": "City",
    "billStateProvince": "Illinois",
    "billZip": "23434",
    "billCountry": "United States",
    "billPhone": "457657657",
    "billFax": "657657",
    "billEmail": "[e-mail]",
    "shipFirstName": "Simon",
    "shipLastName": "Watts",
    "shipCompany": "B",
    "shipCompany2": "B",
    "shipAddress1": "Address",
    "shipAddress2": "Address",
    "shipCity": "City",
    "shipStateProvince": "California",
    "shipZip": "345435",
    "shipCountry": "United States",
    "shipPhone": "345435",
    "shipFax": "235435",
    "shipEmail": "[e-mail]",
    "partnerLogin": null,
    "separateShipAddr": false,
    "isNotifyEmail": true,
    "isNotifyFax": false,
    "isUserAdminPermEnabled": true,
    "isWebServicesOnly": false,
    "isAccessAdminPermEnabled": true,
    "isProxyPermEnabled": true,
    "type": {
        "value": "FULL_ACCESS",
        "displayValue": "FullAccess"
    },
    "language": {
        "value": "en_US",
        "displayValue": "English"
    },
    "currency": {
        "value": "USD",
        "displayValue": "US Dollar"
    },
    "numberFormat": {
        "value": 1,
        "displayValue": "####,##"
    },
    "timeZone": {
        "value": "America/Los_Angeles",
        "displayValue": "(GMT-8:00 GMT-7:00) Los Angeles"
    },
    "dateFormat": {
        "value": 16,
        "displayValue": "dd/MM/yyyy h:mm a"
    },
    "status": {
        "value": 1,
        "displayValue": "Active"
    },
    "enabledForSso": {
        "value": "SSO_ENABLED",
        "displayValue": "Enabled for SSO"
    },
     "groups": {
        "items": [
            {
                "label": "100k Parts",
                "variableName": "a100kparts",
                "type": "Sales"
            }
        ]
     }
}

Response Body Sample

{
  "login": "simon.watts",
  "isNotifyFax": false,
  "firstName": "Simon",
  "jobTitle": "Sales Manager Administrator",
  "email": "[e-mail]",
  "phone": "2622622627",
  "fax": "2622622655",
  "billLastName": "Watts",
  "billCompany": "abc",
  "billCompany2": "jkl",
  "billAddress1": "Address",
  "billAddress2": "Address",
  "billCity": "City",
  "billStateProvince": "Illinois",
  "billZip": "23434",
  "billCountry": "United States",
  "billPhone": "457657657",
  "billFax": "657657",
  "billEmail": "[e-mail]",
  "shipFirstName": "Simon",
  "shipLastName": "Watts",
  "shipCompany": "B",
  "shipCompany2": "B",
  "shipAddress1": "Address",
  "shipAddress2": "Address",
  "shipCity": "City",
  "shipStateProvince": "California",
  "shipZip": "345435",
  "shipCountry": "United States",
  "shipPhone": "345435",
  "shipFax": "235435",
  "shipEmail": "[e-mail]",
  "separateShipAddr": false,
  "isNotifyEmail": true,
  "isUserAdminPermEnabled": true,
  "isWebServicesOnly": false,
  "isAccessAdminPermEnabled": true,
  "isProxyPermEnabled": true,
  "partyId": 935719302534024740,
  "partyNumber": "935719302534024740",
  "dateModified": "2024-05-13T23:02:43.000Z",
  "dateAdded": "2024-05-13T23:02:42.000Z",
  "links": [{
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v19/users/935719302534024740"
    }, {
      "rel": "child",
      "href": "http://sitename.oracle.com/rest/v19/users/935719302534024740/groups"
    }
  ],
  "type": {
    "value": "FULL_ACCESS",
    "displayValue": "FullAccess"
  },
  "language": {
    "value": "en_US",
    "displayValue": "English"
  },
  "currency": {
    "value": "USD",
    "displayValue": "US Dollar"
  },
  "numberFormat": {
    "value": 1,
    "displayValue": "####,##"
  },
  "timeZone": {
    "value": "America/Los_Angeles",
    "displayValue": "(GMT-8:00 GMT-7:00) Los Angeles"
  },
  "units": {
    "value": 1,
    "displayValue": "English"
  },
  "dateFormat": {
    "value": 16,
    "displayValue": "dd/MM/yyyy h:mm a"
  },
  "status": {
    "value": 1,
    "displayValue": "Active"
  },
  "enabledForSso": {
    "value": "SSO_ENABLED",
    "displayValue": "Enabled for SSO"
  },
  "company": {
    "name": "VisionServices",
    "loginName": "visionservices1"
  }
}

Back to Top