Documentation sur Oracle Cloud Infrastructure

Spécifications d'API de gestion des utilisateurs en libre-service

Utilisez l'API de gestion des utilisateurs en libre-service pour obtenir des informations sur le profil, les détails des clients, les numéros CSI associés aux clients, les informations sur la configuration des clients et les fonctionnalités en libre-service offertes aux clients. Elle permet également à l'utilisateur de définir ses préférences en matière de fuseau horaire.

Les ressources suivantes sont prises en charge :

Obtenir l'utilisateur

Utilisez cette API pour obtenir les détails d'un 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 ne pouvez accéder qu'à vos détails.

En-têtes

  • Autorisation : <Jeton> du porteur

    Où <Jeton> est le jeton OAUTH retourné 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 du client dans la plate-forme en libre-service.

Chemin de base

/selfservice/v1/

Fonctionnalité

Cette API retourne les détails de l'utilisateur tels que le prénom, le nom de famille, l'adresse de courriel, l'employé et sa préférence en matière de fuseau horaire.

Verbe

GET

Exemple de réponse

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

Obtenir le client pour un utilisateur

Utilisez cette API pour obtenir les détails du 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 ne pouvez accéder qu'aux détails d'un client.

En-têtes

  • Autorisation : <Jeton> du porteur

    Où <Jeton> est le jeton OAUTH retourné 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 du client dans la plate-forme en libre-service.

Chemin de base

/selfservice/v1/

Fonctionnalité

  • Cette API retourne des détails du client d'un utilisateur tels que l'ID client, le nom du client et le code de client.
  • Cette API obtient l'ID client, car d'autres API nécessitent cette valeur.

Verbe

GET

Exemple de réponse 

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

Définir les préférences d'utilisateur

Utilisez cette API pour définir les préférences d'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 ne pouvez définir que vos préférences.

En-têtes

  • Autorisation : <Jeton> du porteur

    Où <Jeton> est le jeton OAUTH retourné 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 du client dans la plate-forme en libre-service.

Chemin de base

/selfservice/v1/

Dépendance

Fonctionnalité

  • Cette API définit la préférence de l'utilisateur en matière de fuseau horaire.
  • Vous pouvez définir toute valeur d'ID fuseau horaire standard.

Verbe

PUT

Exemple de demande 

{
  "timezone": "US/Eastern"
}

Exemple de réponse

HTTP response code : 200

Obtenir tous les numéros CSI pour un utilisateur

Utilisez cette API pour obtenir tous les identificateurs de soutien à la clientèle (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 ne pouvez accéder qu'aux numéros CSI d'un client.

En-têtes

  • Autorisation : <Jeton> du porteur

    Où <Jeton> est le jeton OAUTH retourné 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 du client dans la plate-forme en libre-service.

Chemin de base

/selfservice/v1/

Fonctionnalité

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

Verbe

GET

Exemple de réponse

[
  15427061
]

Obtenir la configuration pour un numéro CSI

Utilisez cette API pour obtenir toutes les configurations par identificateur de soutien à la clientèle (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 ne pouvez accéder qu'à la configuration des numéros CSI d'un client.

En-têtes

  • Autorisation : <Jeton> du porteur

    Où <Jeton> est le jeton OAUTH retourné 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 du client dans la plate-forme en libre-service.

Chemin de base

/selfservice/v1/

Fonctionnalité

Dépendance

Obtenir 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"
  }
]

Obtenir 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 ne pouvez accéder qu'à la configuration d'un client.

En-têtes

  • Autorisation : <Jeton> du porteur

    Où <Jeton> est le jeton OAUTH retourné 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 du client dans la plate-forme en libre-service.

Chemin de base

/selfservice/v1/

Fonctionnalité

  • Cette API liste toutes les configurations telles que les services et l'instance pour un client identifié par l'ID client.
  • {customerId} peut être extrait à l'aide de l'API Obtenir le client pour un utilisateur.

Dépendance

Obtenir le 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"
  }
]

Obtenir les privilèges d'un client

Utilisez cette API pour obtenir tous les privilèges d'un 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 ne pouvez accéder qu'aux données de privilèges d'un client.

En-têtes

  • Autorisation : <Jeton> du porteur

    Où <Jeton> est le jeton OAUTH retourné 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 du client dans la plate-forme en libre-service.

Chemin de base

/selfservice/v1/

Fonctionnalité

  • Cette API retourne tous les privilèges d'un client.
  • Les privilèges du client sont au niveau du catalogue de services. Par exemple, si le client peut accéder au module de personnalisations CEMLI ou au module d'arrêt/redémarrage.
  • {customerId}peut être extrait à l'aide de l'API Obtenir le client pour un utilisateur.

Dépendance

Obtenir le client pour un utilisateur.

Verbe

GET

Exemple de réponse

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