Documentation Oracle Cloud Infrastructure

Spécifications de l'API utilisateur en libre-service

Employez l'API utilisateur en libre-service pour obtenir les informations de profil, les détails client, le numéro CSI associé au client, les informations de configuration du client et les fonctionnalités en libre-service disponibles pour les clients. Elle permet également à l'utilisateur de définir sa préférence de fuseau horaire.

Les ressources suivantes sont prises en charge :

Obtenir l'utilisateur

Utilisez cette API pour obtenir les détails utilisateur.

API

/selfservice/v1/users/{userEmail}

Portée et autorisation

  • Vous devez disposer de la portée mcs:oci:api:User pour accéder à cette API.
  • Vous pouvez accéder uniquement aux détails qui vous concernent.

En-têtes

  • Autorisation : <Jeton> du service support

    Où <Jeton> est le jeton OAuth renvoyé par le serveur d'autorisation (jeton JWT).

  • Identificateur : <Identificateur JWKS>

    Où <Identificateur JWKS> est le GUID généré lorsque l'URI JWKS est défini par l'administrateur client dans la plate-forme en libre-service.

Chemin de base

/selfservice/v1/

Fonctionnalité

Cette API renvoie les détails utilisateur tels que le prénom, le nom, l'adresse électronique de l'utilisateur, l'employé et la préférence de fuseau horaire de l'utilisateur.

Verbe

GET

Exemple de réponse

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

Obtention du client pour un utilisateur

Utilisez cette API pour obtenir les détails client.

API

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

Portée et autorisation

  • Vous devez disposer de la portée mcs:oci:api:User pour accéder à cette API.
  • Vous pouvez accéder uniquement aux détails de votre client.

En-têtes

  • Autorisation : <Jeton> du service support

    Où <Jeton> est le jeton OAuth renvoyé par le serveur d'autorisation (jeton JWT).

  • Identificateur : <Identificateur JWKS>

    Où <Identificateur JWKS> est le GUID généré lorsque l'URI JWKS est défini par l'administrateur client dans la plate-forme en libre-service.

Chemin de base

/selfservice/v1/

Fonctionnalité

  • Cette API renvoie les détails du client utilisateur, tels que l'ID, le nom et le code client.
  • Cette API obtient l'ID client car d'autres API exigent cette valeur.

Verbe

GET

Exemple de réponse 

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

Définition des préférences utilisateur

Employez cette API pour définir les préférences utilisateur.

API

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

Portée et autorisation

  • Vous devez disposer de la portée mcs:oci:api:User pour accéder à cette API.
  • Vous pouvez définir uniquement vos préférences.

En-têtes

  • Autorisation : <Jeton> du service support

    Où <Jeton> est le jeton OAuth renvoyé par le serveur d'autorisation (jeton JWT).

  • Identificateur : <Identificateur JWKS>

    Où <Identificateur JWKS> est le GUID généré lorsque l'URI JWKS est défini par l'administrateur client dans la plate-forme en libre-service.

Chemin de base

/selfservice/v1/

Dépendance

Fonctionnalité

  • Cette API permet de définir la préférence de fuseau horaire utilisateur.
  • Vous pouvez définir n'importe quelle valeur d'ID de fuseau horaire standard.

Verbe

PUT

Exemple de demande 

{
  "timezone": "US/Eastern"
}

Exemple de réponse

HTTP response code : 200

Obtention de tous les numéros CSI pour un utilisateur

Utilisez cette API pour obtenir tous les numéros CSI d'un utilisateur.

API

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

Portée et autorisation

  • Vous devez disposer de la portée mcs:oci:api:User pour accéder à cette API.
  • Vous pouvez accéder uniquement aux numéros CSI de votre client.

En-têtes

  • Autorisation : <Jeton> du service support

    Où <Jeton> est le jeton OAuth renvoyé par le serveur d'autorisation (jeton JWT).

  • Identificateur : <Identificateur JWKS>

    Où <Identificateur JWKS> est le GUID généré lorsque l'URI JWKS est défini par l'administrateur client dans la plate-forme en libre-service.

Chemin de base

/selfservice/v1/

Fonctionnalité

Cette API renvoie tous les numéros CSI du client associé à l'utilisateur.

Verbe

GET

Exemple de réponse

[
  15427061
]

Obtention de la configuration pour un numéro CSI

Utilisez cette API pour obtenir toutes les configurations par numéro CSI.

API

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

Portée et autorisation

  • Vous devez disposer de la portée mcs:oci:api:User pour accéder à cette API.
  • Vous pouvez accéder uniquement à la configuration des numéros CSI de votre client.

En-têtes

  • Autorisation : <Jeton> du service support

    Où <Jeton> est le jeton OAuth renvoyé par le serveur d'autorisation (jeton JWT).

  • Identificateur : <Identificateur JWKS>

    Où <Identificateur JWKS> est le GUID généré lorsque l'URI JWKS est défini par l'administrateur client dans la plate-forme en libre-service.

Chemin de base

/selfservice/v1/

Fonctionnalité

Dépendance

Obtention de tous les numéros CSI pour un utilisateur

Verbe

GET

Exemple de réponse

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

Obtention de la configuration pour un client

Utilisez cette API pour obtenir la configuration par ID client.

API

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

Portée et autorisation

  • Vous devez disposer de la portée mcs:oci:api:User pour accéder à cette API.
  • Vous pouvez accéder uniquement à la configuration de votre client.

En-têtes

  • Autorisation : <Jeton> du service support

    Où <Jeton> est le jeton OAuth renvoyé par le serveur d'autorisation (jeton JWT).

  • Identificateur : <Identificateur JWKS>

    Où <Identificateur JWKS> est le GUID généré lorsque l'URI JWKS est défini par l'administrateur client dans la plate-forme en libre-service.

Chemin de base

/selfservice/v1/

Fonctionnalité

  • Cette API répertorie toutes les configurations telles que les services et l'instance pour un client identifié par son ID.
  • {customerId} peut être extrait via l'API Obtention du client pour un utilisateur.

Dépendance

Obtention du client pour un utilisateur

Verbe

GET

Exemple de réponse

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

Obtention des privilèges client

Utilisez cette API pour obtenir tous les privilèges client.

API

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

Portée et autorisation

  • Vous devez disposer de la portée mcs:oci:api:User pour accéder à cette API.
  • Vous pouvez accéder uniquement aux données des privilèges de votre client.

En-têtes

  • Autorisation : <Jeton> du service support

    Où <Jeton> est le jeton OAuth renvoyé par le serveur d'autorisation (jeton JWT).

  • Identificateur : <Identificateur JWKS>

    Où <Identificateur JWKS> est le GUID généré lorsque l'URI JWKS est défini par l'administrateur client dans la plate-forme en libre-service.

Chemin de base

/selfservice/v1/

Fonctionnalité

  • Cette API renvoie tous les privilèges client.
  • Les privilèges client se trouvent au niveau du catalogue de services. Par exemple : pour déterminer si le client peut accéder au module CEMLI ou au module de redémarrage.
  • {customerId} peut être extrait via l'API Obtention du client pour un utilisateur.

Dépendance

Obtention du client pour un utilisateur

Verbe

GET

Exemple de réponse

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