Oracle Cloud Infrastructure-Dokumentation

Selfservicebenutzer-API - Spezifikationen

Mit der Selfservice-Benutzer-API erhalten Sie Profilinformationen, Kundendetails, die mit dem Kunden verknüpfte CSI-Nummer, Konfigurationsinformationen des Kunden und Selfservice-Funktionen, die seinen Kunden zur Verfügung stehen. Außerdem können Benutzer ihre Zeitzonenvoreinstellungen festlegen.

Die folgenden Ressourcen werden unterstützt:

Benutzer abrufen

Mit dieser API können Sie Benutzerdetails abrufen.

API

/selfservice/v1/users/{userEmail}

Geltungsbereich und AuthZ

  • Sie benötigen den Geltungsbereich mcs:oci:api:User, um auf diese API zugreifen zu können.
  • Sie können nur auf Ihre Details zugreifen.

Header

  • Autorisierung: Bearer <Token>

    Dabei ist <Token> das OAUTH-Token, das vom Autorisierungsserver zurückgegeben wird (JWT-Token).

  • ID: <JWKS Identifier>

    Dabei ist <JWKS Identifier> die GUID, die generiert wird, wenn die JWKS-URI vom Kundenadministrator in der Selfserviceplattform festgelegt wird.

Basispfad

/selfservice/v1/

Funktionalität

Diese API gibt die Benutzerdetails zurück, wie Vorname, Nachname, E-Mail-Adresse des Benutzers, Mitarbeiter und Zeitzonenvoreinstellung des Benutzers.

Verb

GET

Beispielantwort

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

Kunden für einen Benutzer abrufen

Mit dieser API können Sie Kundendetails abrufen.

API

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

Geltungsbereich und AuthZ

  • Sie benötigen den Geltungsbereich mcs:oci:api:User, um auf diese API zugreifen zu können.
  • Sie können nur auf Ihre Kundendetails zugreifen.

Header

  • Autorisierung: Bearer <Token>

    Dabei ist <Token> das OAUTH-Token, das vom Autorisierungsserver zurückgegeben wird (JWT-Token).

  • ID: <JWKS Identifier>

    Dabei ist <JWKS Identifier> die GUID, die generiert wird, wenn die JWKS-URI vom Kundenadministrator in der Selfserviceplattform festgelegt wird.

Basispfad

/selfservice/v1/

Funktionalität

  • Diese API gibt Benutzerkundendetails wie Kunden-ID, Kundenname und Kundencode zurück.
  • Diese API ruft die Kunden-ID ab, da für andere APIs dieser Wert erforderlich ist.

Verb

GET

Beispielantwort 

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

Benutzereinstellungen festlegen

Mit dieser API können Sie die Benutzervoreinstellungen festlegen.

API

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

Geltungsbereich und AuthZ

  • Sie benötigen den Geltungsbereich mcs:oci:api:User, um auf diese API zugreifen zu können.
  • Sie können nur Ihre Voreinstellungen festlegen.

Header

  • Autorisierung: Bearer <Token>

    Dabei ist <Token> das OAUTH-Token, das vom Autorisierungsserver zurückgegeben wird (JWT-Token).

  • ID: <JWKS Identifier>

    Dabei ist <JWKS Identifier> die GUID, die generiert wird, wenn die JWKS-URI vom Kundenadministrator in der Selfserviceplattform festgelegt wird.

Basispfad

/selfservice/v1/

Abhängigkeit

Funktionalität

  • Diese API legt die Voreinstellung für die Zeitzone des Benutzers fest.
  • Sie können alle Standardwerte für die Zeitzonen-ID festlegen.

Verb

PUT

Beispielanforderung 

{
  "timezone": "US/Eastern"
}

Beispielantwort

HTTP response code : 200

Alle CSIs für einen Benutzer abrufen

Mit dieser API können Sie alle CSI-(Customer Support Identifier-)Nummern für einen Benutzer abrufen.

API

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

Geltungsbereich und AuthZ

  • Sie benötigen den Geltungsbereich mcs:oci:api:User, um auf diese API zugreifen zu können.
  • Sie können nur auf Ihre Kunden-CSIs zugreifen.

Header

  • Autorisierung: Bearer <Token>

    Dabei ist <Token> das OAUTH-Token, das vom Autorisierungsserver zurückgegeben wird (JWT-Token).

  • ID: <JWKS Identifier>

    Dabei ist <JWKS Identifier> die GUID, die generiert wird, wenn die JWKS-URI vom Kundenadministrator in der Selfserviceplattform festgelegt wird.

Basispfad

/selfservice/v1/

Funktionalität

Diese API gibt alle CSIs für den Kunden zurück, der mit dem Benutzer verknüpft ist.

Verb

GET

Beispielantwort

[
  15427061
]

Konfiguration für eine CSI abrufen

Mit dieser API können Sie alle Konfigurationen nach CSI-(Customer Support Identifier-)Nummer abrufen.

API

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

Geltungsbereich und AuthZ

  • Sie benötigen den Geltungsbereich mcs:oci:api:User, um auf diese API zugreifen zu können.
  • Sie können nur auf die CSI-Konfiguration für Ihre Kunden zugreifen.

Header

  • Autorisierung: Bearer <Token>

    Dabei ist <Token> das OAUTH-Token, das vom Autorisierungsserver zurückgegeben wird (JWT-Token).

  • ID: <JWKS Identifier>

    Dabei ist <JWKS Identifier> die GUID, die generiert wird, wenn die JWKS-URI vom Kundenadministrator in der Selfserviceplattform festgelegt wird.

Basispfad

/selfservice/v1/

Funktionalität

Abhängigkeit

Alle CSIs für einen Benutzer abrufen.

Verb

GET

Beispielantwort

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

Konfiguration für einen Kunden abrufen

Mit dieser API können Sie die Konfiguration nach Kunden-ID abrufen.

API

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

Geltungsbereich und AuthZ

  • Sie benötigen den Geltungsbereich mcs:oci:api:User, um auf diese API zugreifen zu können.
  • Sie können nur auf Ihre Kundenkonfiguration zugreifen.

Header

  • Autorisierung: Bearer <Token>

    Dabei ist <Token> das OAUTH-Token, das vom Autorisierungsserver zurückgegeben wird (JWT-Token).

  • ID: <JWKS Identifier>

    Dabei ist <JWKS Identifier> die GUID, die generiert wird, wenn die JWKS-URI vom Kundenadministrator in der Selfserviceplattform festgelegt wird.

Basispfad

/selfservice/v1/

Funktionalität

  • Diese API listet alle Konfigurationen auf, wie Services und Instanzen für einen Kunden, der durch die Kunden-ID identifiziert wird.
  • {customerId} kann mit der API Kunden für einen Benutzer abrufen abgerufen werden.

Abhängigkeit

Kunden für einen Benutzer abrufen

Verb

GET

Beispielantwort

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

Kundenberechtigungen abrufen

Mit dieser API können Sie alle Kundenberechtigungen abrufen.

API

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

Geltungsbereich und AuthZ

  • Sie benötigen den Geltungsbereich mcs:oci:api:User, um auf diese API zugreifen zu können.
  • Sie können nur auf Daten zu Ihren Kundenberechtigungen zugreifen.

Header

  • Autorisierung: Bearer <Token>

    Dabei ist <Token> das OAUTH-Token, das vom Autorisierungsserver zurückgegeben wird (JWT-Token).

  • ID: <JWKS Identifier>

    Dabei ist <JWKS Identifier> die GUID, die generiert wird, wenn die JWKS-URI vom Kundenadministrator in der Selfserviceplattform festgelegt wird.

Basispfad

/selfservice/v1/

Funktionalität

  • Diese API gibt alle Kundenberechtigungen zurück.
  • Kundenberechtigungen befinden sich auf der Servicekatalogebene. Beispiel: Der Kunde kann auf das CEMLI-Modul oder das Bounce-Modul zugreifen.
  • {customerId}kann mit der API Kunden für einen Benutzer abrufen abgerufen werden.

Abhängigkeit

Kunden für einen Benutzer abrufen

Verb

GET

Beispielantwort

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