1. REST API for Oracle B2C Service
  2. Tasks
  3. Accounts

Get an account

get

/services/rest/connect/v1.4/accounts/{id}

Request

Path Parameters
Back to Top

Response

Default Response

Body ()
Root Schema : accounts
Type: object
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on.
Show Source
Nested Schema : accountHierarchy
Type: array
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resources.
Show Source
Nested Schema : accounts-attributes
Type: object
The group of flags used for setting certain features or special behaviors for an account.
Show Source
  • Indicates whether the account is temporarily locked. For example, you may lock a staff member's account who has taken a leave of absence. An account automatically gets locked if the staff member has exceeded the number of invalid login attempts or if the password has expired. The default value is false.
  • Indicates whether the staff member can modify the email signature. The default value is false.
  • Indicates whether the staff member must change the password at the next login. The value remains true until the staff member changes the password. The default value is false.
  • Indicates whether the staff member is considered as an infrequent user seat, as opposed to a full seat. The default value is false.
  • Indicates whether the staff member's account password never expires. This setting overrides system-wide password expiration configurations. The default value is false.
  • Indicates whether the staff member's account is permanently disabled. For example, an account is permanently disabled when a staff member leaves your organization. A disabled account appears in the tree of the Staff Accounts management console if Show Disabled setting is enabled, but you cannot deselect the Permanently Disable check box if you edit the account. You can reuse the login name of a permanently disabled account for a different account. The default value is false.
  • Indicates whether the staff member's account cannot be assigned to incidents, answers, opportunities, and tasks. The default value is false.
  • Indicates whether the staff member's account cannot be included in the list for filters in reports. The default value is false.
  • Indicates whether the staff member's account is virtual. The default value is false. This attribute is read-only.
Nested Schema : country
Type: object
The details about the countries and provinces which are used to maintain accurate address information for the organizations and contacts in Oracle B2C Service. It is the reference to a resource in 'countries' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : namedIDs-accounts-emailNotification
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : accounts-emails
Type: object
The email address and its associated information.
Show Source
Nested Schema : accounts-name
Type: object
The full name of the person, including the first name and the last name.
Show Source
Nested Schema : accounts-nameFurigana
Type: object
The full name of the person, including the first name and the last name.
Show Source
Nested Schema : accounts-phones
Type: object
The details related to the phone number.
Show Source
  • Maximum Length: 40
    Pattern: ^[][+0-9a-zA-Z[:blank:].,()#-/:]*$
    The free-form phone number including non-numeric characters. For example, 1 (406) 522-4200.
  • namedIDs-accounts-phones-phoneType
    An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
  • Maximum Length: 40
    The automatically populated numeric string derived by excluding the non-numeric characters from the value of the Number attribute. For example, if the Number attribute has a value of 1 (406) 522-4200, this field is populated as 14065224200. This attribute is read-only.
Nested Schema : namedIDs-accounts-profile
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : accounts-salesSettings
Type: object
The sales-related information of the account.
Show Source
Nested Schema : accounts-serviceSettings
Type: object
The service-related information of the account.
Show Source
  • Minimum Value: 1
    Maximum Value: 65535
    The port number assigned for screen-pop alerts for the staff account. It is used in Citrix and Terminal Services environments where there are multiple agents logged in to different sessions on the same machine.
Nested Schema : namedIDs-accounts-staffGroup
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : items
Type: object
Nested Schema : namedIDs-accounts-emails-addressType
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-accounts-phones-phoneType
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-accounts-salesSettings-defaultCurrency
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Back to Top

Examples

Use GET with the following syntax to retrieve data for an account object:

https://your_site_interface/services/rest/connect/version/accounts/account_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/accounts/1

Response body example

{
  "id": 1,
  "lookupName": "Administrator -",
  "accountHierarchy": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/1/accountHierarchy"
      }
    ]
  },
  "attributes": {
    "accountLocked": false,
    "canModifyEmailSignature": false,
    "forcePasswordChange": false,
    "infrequentUser": false,
    "passwordNeverExpires": false,
    "permanentlyDisabled": false,
    "staffAssignmentDisabled": true,
    "viewsReportsDisabled": true,
    "virtualAccount": false
  },
  "country": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/countries/1"
      },
      {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/countries/1"
      },
      {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/countries",
        "mediaType": "application/schema+json"
      }
    ]
  },
  "customFields": {
    "c": {}
  },
  "displayName": "Administrator",
  "emailNotification": null,
  "emails": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/1/emails"
      }
    ]
  },
  "login": "administrator",
  "manager": null,
  "name": {
    "first": "Administrator",
    "last": "-"
  },
  "nameFurigana": {
    "first": null,
    "last": null
  },
  "notificationPending": false,
  "passwordExpirationTime": "2020-12-31T09:00:00.000Z",
  "phones": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/1/phones"
      }
    ]
  },
  "profile": {
    "id": 1,
    "lookupName": "Full Access"
  },
  "salesSettings": {
    "defaultCurrency": {
      "id": 1,
      "lookupName": "USD"
    },
    "territory": null
  },
  "serviceSettings": {},
  "signature": null,
  "staffGroup": null,
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/1"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/1"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts",
      "mediaType": "application/schema+json"
    }
  ]
}
Back to Top