Documentazione di Oracle Cloud Infrastructure

Specifiche API utente self-service

Utilizzare l'API utente self-service per ottenere informazioni sul profilo, dettagli cliente, CSI associati al cliente, informazioni di configurazione del cliente e funzionalità self-service disponibili per i clienti. Consente inoltre all'utente di impostare la preferenza di fuso orario.

Sono supportate le seguenti risorse:

Recupera utente

Utilizzare questa API per ottenere i dettagli utente.

API

/selfservice/v1/users/{userEmail}

Ambito e AuthZ

  • Per accedere a questa API, è necessario disporre dell'ambito mcs:oci:api:User.
  • Puoi accedere solo ai tuoi dati.

Intestazioni

  • Autorizzazione: Bearer <Token>

    Dove <Token> è il token OAUTH restituito dal server di autorizzazione (token JWT).

  • Identificativo: <ID JWKS>

    Dove <JWKS Identifier> è il GUID generato quando l'URI JWKS è impostato dall'amministratore del cliente nella piattaforma self-service.

Percorso di base

/selfservice/v1/

Funzionalità

Questa API restituisce i dettagli utente, ad esempio nome, cognome, e-mail utente, dipendente e preferenza di fuso orario utente.

Verbo

GET

Risposta di esempio

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

Recupera cliente per un utente

Utilizzare questa API per ottenere i dettagli del cliente.

API

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

Ambito e AuthZ

  • Per accedere a questa API, è necessario disporre dell'ambito mcs:oci:api:User.
  • È possibile accedere solo ai dettagli del cliente.

Intestazioni

  • Autorizzazione: Bearer <Token>

    Dove <Token> è il token OAUTH restituito dal server di autorizzazione (token JWT).

  • Identificativo: <ID JWKS>

    Dove <JWKS Identifier> è il GUID generato quando l'URI JWKS è impostato dall'amministratore del cliente nella piattaforma self-service.

Percorso di base

/selfservice/v1/

Funzionalità

  • Questa API restituisce i dettagli del cliente utente, ad esempio ID cliente, nome cliente e codice cliente.
  • Questa API recupera l'ID cliente poiché altre API richiedono questo valore.

Verbo

GET

Risposta di esempio 

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

Imposta le preferenze utente

Utilizzare questa API per impostare le preferenze utente.

API

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

Ambito e AuthZ

  • Per accedere a questa API, è necessario disporre dell'ambito mcs:oci:api:User.
  • È possibile impostare solo le preferenze.

Intestazioni

  • Autorizzazione: Bearer <Token>

    Dove <Token> è il token OAUTH restituito dal server di autorizzazione (token JWT).

  • Identificativo: <ID JWKS>

    Dove <JWKS Identifier> è il GUID generato quando l'URI JWKS è impostato dall'amministratore del cliente nella piattaforma self-service.

Percorso di base

/selfservice/v1/

Dipendenza

Funzionalità

  • Questa API imposta la preferenza di fuso orario dell'utente.
  • È possibile impostare qualsiasi valore di ID fuso orario standard.

Verbo

PUT

Richiesta di esempio 

{
  "timezone": "US/Eastern"
}

Risposta di esempio

HTTP response code : 200

Recupera tutti i CSI per un utente

Utilizzare questa API per ottenere tutti gli identificativi CSI (Customer Support Identifiers) per un utente.

API

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

Ambito e AuthZ

  • Per accedere a questa API, è necessario disporre dell'ambito mcs:oci:api:User.
  • È possibile accedere solo ai CSI dei clienti.

Intestazioni

  • Autorizzazione: Bearer <Token>

    Dove <Token> è il token OAUTH restituito dal server di autorizzazione (token JWT).

  • Identificativo: <ID JWKS>

    Dove <JWKS Identifier> è il GUID generato quando l'URI JWKS è impostato dall'amministratore del cliente nella piattaforma self-service.

Percorso di base

/selfservice/v1/

Funzionalità

Questa API restituisce tutti i CSI per il cliente associato all'utente.

Verbo

GET

Risposta di esempio

[
  15427061
]

Recupero della configurazione per un CSI

Utilizzare questa API per ottenere tutte le configurazioni in base al codice CSI (Customer Support Identifier).

API

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

Ambito e AuthZ

  • Per accedere a questa API, è necessario disporre dell'ambito mcs:oci:api:User.
  • È possibile accedere solo alla configurazione dei CSI del cliente.

Intestazioni

  • Autorizzazione: Bearer <Token>

    Dove <Token> è il token OAUTH restituito dal server di autorizzazione (token JWT).

  • Identificativo: <ID JWKS>

    Dove <JWKS Identifier> è il GUID generato quando l'URI JWKS è impostato dall'amministratore del cliente nella piattaforma self-service.

Percorso di base

/selfservice/v1/

Funzionalità

  • Questa API elenca tutte le configurazioni, ad esempio i servizi e le istanze per il CSI.
  • È possibile recuperare {supportIdentifier} (CSI) utilizzando l'API Get all CSI for a user.

Dipendenza

Ottieni tutti i CSI per un utente.

Verbo

GET

Risposta di esempio

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

Recupera configurazione per un cliente

Utilizzare questa API per ottenere la configurazione in base all'ID cliente.

API

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

Ambito e AuthZ

  • Per accedere a questa API, è necessario disporre dell'ambito mcs:oci:api:User.
  • È possibile accedere solo alla configurazione del cliente.

Intestazioni

  • Autorizzazione: Bearer <Token>

    Dove <Token> è il token OAUTH restituito dal server di autorizzazione (token JWT).

  • Identificativo: <ID JWKS>

    Dove <JWKS Identifier> è il GUID generato quando l'URI JWKS è impostato dall'amministratore del cliente nella piattaforma self-service.

Percorso di base

/selfservice/v1/

Funzionalità

  • Questa API elenca tutte le configurazioni, ad esempio servizi e istanza, per un cliente identificato dall'ID cliente.
  • È possibile recuperare {customerId} utilizzando l'API Recupera cliente per un utente.

Dipendenza

Recupera cliente per un utente.

Verbo

GET

Risposta di esempio

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

Recupera privilegi cliente

Utilizzare questa API per ottenere tutti i privilegi del cliente.

API

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

Ambito e AuthZ

  • Per accedere a questa API, è necessario disporre dell'ambito mcs:oci:api:User.
  • È possibile accedere solo ai dati relativi ai privilegi dei clienti.

Intestazioni

  • Autorizzazione: Bearer <Token>

    Dove <Token> è il token OAUTH restituito dal server di autorizzazione (token JWT).

  • Identificativo: <ID JWKS>

    Dove <JWKS Identifier> è il GUID generato quando l'URI JWKS è impostato dall'amministratore del cliente nella piattaforma self-service.

Percorso di base

/selfservice/v1/

Funzionalità

  • Questa API restituisce tutti i privilegi del cliente.
  • I privilegi del cliente sono a livello di catalogo servizi. Se ad esempio il cliente può accedere al modulo CEMLI o al modulo Bounce.
  • È possibile recuperare {customerId}utilizzando l'API Recupera cliente per un utente.

Dipendenza

Recupera cliente per un utente.

Verbo

GET

Risposta di esempio

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