Oracle Cloud Infrastructure Documentation

Self-Service User API Specifications

Use the Self-Service User API to get profile information, customer details, CSI associated with their customer, configuration information of their customer, and self-service functionalities available to their customers. It also provides user to set their timezone preference.

The following resources are supported:

Get User

Use this API to get user details.

API

/selfservice/v1/users/{userEmail}

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can access only your details.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/selfservice/v1/

Functionality

This API returns the user details such as first name, last name, user email, employee, and user timezone preference.

Verb

GET

Sample response

{
  "firstName": "<first name>",
  "lastName": "<last name>",
  "userEmail": "<email ID>",
   "userPreferences": {
    "timezone": "US/Eastern"
  }
}

Get Customer for a User

Use this API to get customer details.

API

/selfservice/v1/users/{userEmail}/customers/

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can access only your customer details.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/selfservice/v1/

Functionality

  • This API returns user customer details such as customer ID, customer name, and customer code.
  • This API gets the customer ID as other APIs require this value.

Verb

GET

Sample response 

{
  "customers": [
    {
      "customerId": 1417,
      "customerName": "ORACLE GLOBAL HOSTED SUPPORT (Internal)",
      "customerCode": "OGHS"
    }
  ]
}

Set User Preferences

Use this API to set the user preferences.

API

/selfservice/v1/users/{userEmail}/preferences/

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can set only your preferences.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/selfservice/v1/

Dependency

Functionality

  • This API sets the user timezone preference.
  • You can set any standard timezone ID values.

Verb

PUT

Sample request 

{
  "timezone": "US/Eastern"
}

Sample response

HTTP response code : 200

Get all CSI for a User

Use this API to get all the Customer Support Identifiers (CSI) for a user.

API

/selfservice/v1/users/{userEmail}/customers/supportidentifiers/

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can access only your customer CSIs.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/selfservice/v1/

Functionality

This API returns all the CSIs for the customer associated with the user.

Verb

GET

Sample response

[
  15427061
]

Get Configuration for a CSI

Use this API to get all the configurations by Customer Support Identifier (CSI).

API

/selfservice/v1/users/{userEmail}/customers/configuration/{supportIdentifier}

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can access only your customer CSIs configuration.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/selfservice/v1/

Functionality

  • This API lists all the configuration such as services and instances for the CSI.
  • {supportIdentifier} (CSI) can be fetched using Get all CSI for a user API.

Dependency

Get all CSI for a user.

Verb

GET

Sample response

[
  {
    "customerCode": "OGHS",
    "customerId": 1417,
    "customerName": "ORACLE GLOBAL HOSTED SUPPORT (Internal)",
    "instances": [
      {
        "id": 1689,
        "label": "DOGHSI",
        "name": "DEV",
        "prioritization": "Production Services",
      }
    ],
    "phase": "Implementation",
    "serviceId": 1305,
    "serviceName": "Global Aux SR Process",
    "typeCode": "EBSO"
  }
]

Get Configuration for a Customer

Use this API to get the configuration by customer ID.

API

/selfservice/v1/users/{userEmail}/customers/{customerId}/configuration

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can access only your customer configuration.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/selfservice/v1/

Functionality

  • This API list all the configuration such as services and instance for a customer identified by customer ID.
  • {customerId} can be fetched using Get Customer for a user API.

Dependency

Get customer for a user.

Verb

GET

Sample response

[
  {
    "customerCode": "OGHS",
    "customerId": 1417,
    "customerName": "ORACLE GLOBAL HOSTED SUPPORT (Internal)",
    "instances": [
      {
        "id": 1689,
        "label": "DOGHSI",
        "name": "DEV",
        "prioritization": "Production Services",
      }
    ],
    "phase": "Implementation",
    "serviceId": 1305,
    "serviceName": "Global Aux SR Process",
    "typeCode": "EBSO"
  },
  {
    "customerCode": "OGHS",
    "customerId": 1417,
    "customerName": "ORACLE GLOBAL HOSTED SUPPORT (Internal)",
    "instances": [
      {
        "id": 349004464,
        "label": "TANPCO",
        "name": "TANPCO",
        "prioritization": "Implementation Services",
      }
    ],
    "phase": "Production",
    "serviceId": 315694690,
    "serviceName": "Internal R12  eBiz Instance for R12.2 Patch Testing",
    "typeCode": "OTOI"
  }
]

Get Customer Privileges

Use this API to get all the customer privileges.

API

/selfservice/v1/customers/{customerId}/privileges

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can access only your customer privileges data.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/selfservice/v1/

Functionality

  • This API returns all the customer privileges.
  • Customer privileges are at service catalog level. For example, if the customer can access CEMLI module or Bounce module.
  • {customerId}can be fetched using Get Customer for a user API.

Dependency

Get customer for a user.

Verb

GET

Sample response

{
  "bounce": true,
  "cemli": true,
  "config": true
}