Documentação do Oracle Cloud Infrastructure

Especificações da API de Usuário de Autoatendimento

Use a API de Usuário de Autoatendimento para obter informações de perfil, detalhes do cliente, CSI associado ao cliente, informações de configuração do cliente e funcionalidades de autoatendimento disponíveis aos seus clientes. Ele também permite que o usuário defina sua preferência de fuso horário.

Os seguintes recursos são suportados:

Obter Usuário

Use essa API para obter detalhes do usuário.

API

/selfservice/v1/users/{userEmail}

Escopo e AuthZ

  • Você deve ter o escopo mcs:oci:api:User para acessar essa API.
  • Você só pode acessar seus detalhes.

Cabeçalhos

  • Autorização: <Token> do Portador

    Em que <Token> é o token OAUTH retornado pelo Servidor de Autorização (Token JWT).

  • Identificador: <Identificador JWKS>

    Em que <Identificador JWKS> é o GUID gerado quando o URI do JWKS é definido pelo administrador do cliente na plataforma de autoatendimento.

Caminho Base

/selfservice/v1/

Funcionalidade

Essa API retorna os detalhes do usuário, como nome, sobrenome, e-mail, funcionário e preferência de fuso horário.

Verbo

GET

Resposta de amostra

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

Obter Cliente para um Usuário

Use essa API para obter detalhes do cliente.

API

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

Escopo e AuthZ

  • Você deve ter o escopo mcs:oci:api:User para acessar essa API.
  • Você só pode acessar seus detalhes de cliente.

Cabeçalhos

  • Autorização: <Token> do Portador

    Em que <Token> é o token OAUTH retornado pelo Servidor de Autorização (Token JWT).

  • Identificador: <Identificador JWKS>

    Em que <Identificador JWKS> é o GUID gerado quando o URI do JWKS é definido pelo administrador do cliente na plataforma de autoatendimento.

Caminho Base

/selfservice/v1/

Funcionalidade

  • Essa API retorna detalhes do cliente do usuário, como ID do cliente, nome do cliente e código do cliente.
  • Essa API obtém o ID do cliente, pois outras APIs exigem esse valor.

Verbo

GET

Resposta de amostra 

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

Definir Preferências do Usuário

Use essa API para definir as preferências do usuário.

API

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

Escopo e AuthZ

  • Você deve ter o escopo mcs:oci:api:User para acessar essa API.
  • Você só pode definir suas preferências.

Cabeçalhos

  • Autorização: <Token> do Portador

    Em que <Token> é o token OAUTH retornado pelo Servidor de Autorização (Token JWT).

  • Identificador: <Identificador JWKS>

    Em que <Identificador JWKS> é o GUID gerado quando o URI do JWKS é definido pelo administrador do cliente na plataforma de autoatendimento.

Caminho Base

/selfservice/v1/

Dependência

Funcionalidade

  • Essa API define a preferência de fuso horário do usuário.
  • Você pode definir qualquer valor de ID de fuso horário padrão.

Verbo

PUT

Solicitação de amostra 

{
  "timezone": "US/Eastern"
}

Resposta de amostra

HTTP response code : 200

Obter todos os CSIs para um Usuário

Use essa API para obter todos os Identificadores de Suporte do Cliente (CSI) de um usuário.

API

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

Escopo e AuthZ

  • Você deve ter o escopo mcs:oci:api:User para acessar essa API.
  • Você só pode acessar seus CSIs de cliente.

Cabeçalhos

  • Autorização: <Token> do Portador

    Em que <Token> é o token OAUTH retornado pelo Servidor de Autorização (Token JWT).

  • Identificador: <Identificador JWKS>

    Em que <Identificador JWKS> é o GUID gerado quando o URI do JWKS é definido pelo administrador do cliente na plataforma de autoatendimento.

Caminho Base

/selfservice/v1/

Funcionalidade

Essa API retorna todos os CSIs do cliente associado ao usuário.

Verbo

GET

Resposta de amostra

[
  15427061
]

Obter Configuração para um CSI

Use essa API para obter todas as configurações pelo Identificador de Suporte do Cliente (CSI).

API

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

Escopo e AuthZ

  • Você deve ter o escopo mcs:oci:api:User para acessar essa API.
  • Você só pode acessar a configuração de seus CSIs de cliente.

Cabeçalhos

  • Autorização: <Token> do Portador

    Em que <Token> é o token OAUTH retornado pelo Servidor de Autorização (Token JWT).

  • Identificador: <Identificador JWKS>

    Em que <Identificador JWKS> é o GUID gerado quando o URI do JWKS é definido pelo administrador do cliente na plataforma de autoatendimento.

Caminho Base

/selfservice/v1/

Funcionalidade

  • Essa API lista todas as configurações, como serviços e instâncias para o CSI.
  • O CSI ({supportIdentifier}) pode ser extraído usando a API Obter todos os CSIs para um usuário.

Dependência

Obter todos os CSIs para um usuário.

Verbo

GET

Resposta de amostra

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

Obter Configuração para um Cliente

Use essa API para obter a configuração por ID do cliente.

API

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

Escopo e AuthZ

  • Você deve ter o escopo mcs:oci:api:User para acessar essa API.
  • Você só pode acessar sua configuração de cliente.

Cabeçalhos

  • Autorização: <Token> do Portador

    Em que <Token> é o token OAUTH retornado pelo Servidor de Autorização (Token JWT).

  • Identificador: <Identificador JWKS>

    Em que <Identificador JWKS> é o GUID gerado quando o URI do JWKS é definido pelo administrador do cliente na plataforma de autoatendimento.

Caminho Base

/selfservice/v1/

Funcionalidade

  • Essa API lista todas as configurações, como serviços e instância, para um cliente identificado pelo ID do cliente.
  • {customerId} pode ser extraído usando a API Obter Cliente para um usuário.

Dependência

Obter cliente para um usuário.

Verbo

GET

Resposta de amostra

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

Obter Privilégios do Cliente

Use essa API para obter todos os privilégios de cliente.

API

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

Escopo e AuthZ

  • Você deve ter o escopo mcs:oci:api:User para acessar essa API.
  • Você só pode acessar seus dados de privilégios de cliente.

Cabeçalhos

  • Autorização: <Token> do Portador

    Em que <Token> é o token OAUTH retornado pelo Servidor de Autorização (Token JWT).

  • Identificador: <Identificador JWKS>

    Em que <Identificador JWKS> é o GUID gerado quando o URI do JWKS é definido pelo administrador do cliente na plataforma de autoatendimento.

Caminho Base

/selfservice/v1/

Funcionalidade

  • Essa API retorna todos os privilégios de cliente.
  • Os privilégios de cliente estão no nível do catálogo de serviços. Por exemplo, se o cliente puder acessar o módulo CEMLI ou o módulo Bounce.
  • {customerId} pode ser extraído usando a API Obter Cliente para um usuário.

Dependência

Obter cliente para um usuário.

Verbo

GET

Resposta de amostra

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