Documentación de Oracle Cloud Infrastructure

Especificaciones de API de usuario de autoservicio

Utilice la API de usuario de autoservicio para obtener la información de perfil, los detalles del cliente, el CSI asociado a su cliente, la información de configuración de su cliente y las funcionalidades de autoservicio disponibles para sus clientes. También proporciona al usuario la definición de su preferencia de zona horaria.

Están soportados los siguientes recursos:

Obtener Usuario

Utilice esta API para obtener los detalles del usuario.

API

/selfservice/v1/users/{userEmail}

Ámbito y autorización

  • Debe tener el ámbito mcs:oci:api:User para acceder a esta API.
  • Solo puede acceder a sus detalles.

Cabeceras

  • Autorización: <Token> de portador

    Donde <Token> es el token de OAUTH devuelto por el servidor de autorización (token de JWT).

  • Identificador: <JWKS Identifier>

    Donde <JWKS Identifier> es el identificador único global generado cuando el administrador del cliente define el URI de JWKS en la plataforma de autoservicio.

Ruta de acceso base

/selfservice/v1/

Funcionalidad

Esta API devuelve los detalles del usuario, como el nombre, los apellidos, el correo electrónico del usuario, el empleado y la preferencia de zona horaria del usuario.

Verbo

GET

Solicitud de ejemplo

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

Obtener cliente para un usuario

Utilice esta API para obtener los detalles del cliente.

API

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

Ámbito y autorización

  • Debe tener el ámbito mcs:oci:api:User para acceder a esta API.
  • Solo puede acceder a los detalles de cliente.

Cabeceras

  • Autorización: <Token> de portador

    Donde <Token> es el token de OAUTH devuelto por el servidor de autorización (token de JWT).

  • Identificador: <JWKS Identifier>

    Donde <JWKS Identifier> es el identificador único global generado cuando el administrador del cliente define el URI de JWKS en la plataforma de autoservicio.

Ruta de acceso base

/selfservice/v1/

Funcionalidad

  • Esta API devuelve los detalles de cliente de usuario, como el identificador de cliente, el nombre de cliente y el código de cliente.
  • Esta API obtiene el identificador de cliente, ya que otras API requieren este valor.

Verbo

GET

Solicitud de ejemplo 

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

Definir preferencias de usuario

Utilice esta API para definir las preferencias de usuario.

API

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

Ámbito y autorización

  • Debe tener el ámbito mcs:oci:api:User para acceder a esta API.
  • Solo puede definir sus preferencias.

Cabeceras

  • Autorización: <Token> de portador

    Donde <Token> es el token de OAUTH devuelto por el servidor de autorización (token de JWT).

  • Identificador: <JWKS Identifier>

    Donde <JWKS Identifier> es el identificador único global generado cuando el administrador del cliente define el URI de JWKS en la plataforma de autoservicio.

Ruta de acceso base

/selfservice/v1/

Dependencia

Funcionalidad

  • Esta API define la preferencia de zona horaria del usuario.
  • Puede definir cualquier valor de identificador de zona horaria estándar.

Verbo

PUT

Solicitud de ejemplo 

{
  "timezone": "US/Eastern"
}

Solicitud de ejemplo

HTTP response code : 200

Obtener todos los CSI para un usuario

Utilice esta API para obtener todos los identificadores de soporte del cliente (CSI) para un usuario.

API

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

Ámbito y autorización

  • Debe tener el ámbito mcs:oci:api:User para acceder a esta API.
  • Solo puede acceder a los CSI de su cliente.

Cabeceras

  • Autorización: <Token> de portador

    Donde <Token> es el token de OAUTH devuelto por el servidor de autorización (token de JWT).

  • Identificador: <JWKS Identifier>

    Donde <JWKS Identifier> es el identificador único global generado cuando el administrador del cliente define el URI de JWKS en la plataforma de autoservicio.

Ruta de acceso base

/selfservice/v1/

Funcionalidad

Esta API devuelve todos los CSI del cliente asociado al usuario.

Verbo

GET

Solicitud de ejemplo

[
  15427061
]

Obtener configuración para un CSI

Utilice esta API para obtener todas las configuraciones por Identificador de Soporte del Cliente (CSI).

API

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

Ámbito y autorización

  • Debe tener el ámbito mcs:oci:api:User para acceder a esta API.
  • Solo puede acceder a la configuración de los CSI de su cliente.

Cabeceras

  • Autorización: <Token> de portador

    Donde <Token> es el token de OAUTH devuelto por el servidor de autorización (token de JWT).

  • Identificador: <JWKS Identifier>

    Donde <JWKS Identifier> es el identificador único global generado cuando el administrador del cliente define el URI de JWKS en la plataforma de autoservicio.

Ruta de acceso base

/selfservice/v1/

Funcionalidad

  • Esta API muestra toda la configuración, como los servicios y las instancias, para el CSI.
  • {supportIdentifier} (CSI) se puede recuperar mediante la API Obtener todos los CSI para un usuario.

Dependencia

Obtener todos los CSI para un usuario.

Verbo

GET

Solicitud de ejemplo

[
  {
    "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"
  }
]

Obtener configuración para un cliente

Utilice esta API para obtener la configuración por identificador de cliente.

API

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

Ámbito y autorización

  • Debe tener el ámbito mcs:oci:api:User para acceder a esta API.
  • Puede acceder solo a la configuración de su cliente.

Cabeceras

  • Autorización: <Token> de portador

    Donde <Token> es el token de OAUTH devuelto por el servidor de autorización (token de JWT).

  • Identificador: <JWKS Identifier>

    Donde <JWKS Identifier> es el identificador único global generado cuando el administrador del cliente define el URI de JWKS en la plataforma de autoservicio.

Ruta de acceso base

/selfservice/v1/

Funcionalidad

  • Esta API muestra toda la configuración, como los servicios y la instancia, de un cliente identificado mediante el identificador de cliente.
  • {customerId} se puede recuperar mediante la API Obtener cliente para un usuario.

Dependencia

Obtener cliente para un usuario.

Verbo

GET

Solicitud de ejemplo

[
  {
    "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"
  }
]

Obtener privilegios de cliente

Utilice esta API para obtener todos los privilegios de cliente.

API

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

Ámbito y autorización

  • Debe tener el ámbito mcs:oci:api:User para acceder a esta API.
  • Puede acceder solo a los datos de privilegios de su cliente.

Cabeceras

  • Autorización: <Token> de portador

    Donde <Token> es el token de OAUTH devuelto por el servidor de autorización (token de JWT).

  • Identificador: <JWKS Identifier>

    Donde <JWKS Identifier> es el identificador único global generado cuando el administrador del cliente define el URI de JWKS en la plataforma de autoservicio.

Ruta de acceso base

/selfservice/v1/

Funcionalidad

  • Esta API devuelve todos los privilegios del cliente.
  • Los privilegios de cliente se encuentran en el nivel de catálogo de servicios. Por ejemplo, si el cliente puede acceder al módulo CEMLI o al módulo de reinicio.
  • {customerId}se puede recuperar mediante la API Obtener cliente para un usuario.

Dependencia

Obtener cliente para un usuario.

Verbo

GET

Solicitud de ejemplo

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