Documentación de Oracle Cloud Infrastructure

Referencia REST genérica (basada en IU estándar)

Veamos algunos ejemplos de API de REST para configurar para el sistema orquestado.

Respuesta de solicitud de API de creación de cuenta

Para configurar la API Crear cuenta, utilice el siguiente ejemplo:

Crear detalles de API de cuenta

  • Nombre: Crear usuario
  • Método: POST
  • URL: <target-system>/admin/v1/Users
  • Cabeceras
    • Content-Type: application/json
    • Authorization: <<CREDENTIALS>>. El valor <<CREDENTIALS>> se resuelve en tiempo de ejecución mediante las credenciales introducidas por OCI Vault o por el usuario configuradas en la configuración de integración.
  • Cuerpo de solicitud para API de REST

    El atributo schemas que se muestra en el ejemplo:

    {
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "userName": "<EL>attributes.get('name').get(0)</EL>",
  "name": {
    "givenName": "<EL>attributes.get('firstName').get(0)</EL>",
    "familyName": "<EL>attributes.get('lastName').get(0)</EL>"
  },
  "password": "<EL>attributes.get('password').get(0)</EL>",
  "emails": [
    {
      "value": "<EL>attributes.get('email').get(0)</EL>",
      "type": "work",
      "primary": true
    }
  ]
}
  • Respuesta
    {
  "items": "",
  "responseValues": [],
  "attributes": [
    {
      "name": "uid",
      "value": "<JP>$.id</JP>",
      "responseOfSubRequestId": null,
      "items": null,
      "subAttributes": []
    }
  ]
}
    Esta API crea una cuenta de destino y asigna el identificador devuelto al atributo uid.

API de búsqueda de grupos

Detalles de API de cuenta de búsqueda de grupo

  • Nombre: búsqueda de grupo (permiso)
  • Método: POST
  • URL: <target-system>/admin/v1/Groups/.search
  • Cabeceras
    • Content-Type: application/json
    • Authorization: <<CREDENTIALS>>. El valor <<CREDENTIALS>> se resuelve en tiempo de ejecución mediante las credenciales introducidas por OCI Vault o por el usuario configuradas en la configuración de integración.
  • Cuerpo de solicitud para API de REST

    Incluya el atributo schemas que se muestra en el ejemplo:

    {
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:SearchRequest"
  ],
  "attributes": [
    "displayName",
    "externalId"
  ],
  "sortBy": "displayName",
  "startIndex": "UQ:<EL>currentOffset</EL>",
  "count": "UQ:<EL>limit</EL>"
}
  • Respuesta

    Mediante el editor de JSON, utilice la siguiente respuesta:

    {
  "items": "<JP>$.Resources[*]</JP>",
  "responseValues": [],
  "attributes": [
    {
      "name": "uid",
      "value": "<JP>$.Resources[<EL>currentIndex</EL>].id</JP>",
      "responseOfSubRequestId": null,
      "items": null,
      "subAttributes": []
    },
    {
      "name": "name",
      "value": "<JP>$.Resources[<EL>currentIndex</EL>].displayName</JP>",
      "responseOfSubRequestId": null,
      "items": null,
      "subAttributes": []
    }
  ]
}

API de búsqueda de país

  • Nombre: Buscar países
  • Método: GET
  • URL: <target-system>/admin/v1/AllowedValues/countries
  • Cabeceras
    • Content-Type: application/json
    • Authorization: <<CREDENTIALS>>. El valor <<CREDENTIALS>> se resuelve en tiempo de ejecución mediante las credenciales introducidas por OCI Vault o por el usuario configuradas en la configuración de integración.
  • Respuesta

    Mediante el editor de JSON, utilice la siguiente respuesta:

    {
  "items": "<JP>$.attrValues[*]</JP>",
  "responseValues": [],
  "attributes": [
    {
      "name": "uid",
      "value": "<JP>$.attrValues[<EL>currentIndex</EL>].value</JP>",
      "responseOfSubRequestId": null,
      "items": null,
      "subAttributes": []
    },
    {
      "name": "name",
      "value": "<JP>$.attrValues[<EL>currentIndex</EL>].value</JP>",
      "responseOfSubRequestId": null,
      "items": null,
      "subAttributes": []
    }
  ]
}

Agregar API de afiliación a grupo

  • Nombre: Agregar miembro de grupo
  • Método: PATCH
  • URL: <target-system>/admin/v1/Groups/<EL>attributes.get('groups').get('uid').get(0)</EL>
  • Cabeceras
    • Content-Type: application/json
    • Authorization: <<CREDENTIALS>>. El valor <<CREDENTIALS>> se resuelve en tiempo de ejecución mediante las credenciales introducidas por OCI Vault o por el usuario configuradas en la configuración de integración.
  • Solicitud

    Utilice la siguiente solicitud:

    {
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
          "value": "<EL>attributes.get('uid').get(0)</EL>",
          "type": "User"
        }
      ]
    }
  ]
}
  • Respuesta
    Mediante el editor de JSON, utilice la siguiente respuesta:
    Name: uid
Value: <EL>attributes.get('uid').get(0)</EL>
    O bien, utilice el editor de JSON
    {
  "items": "",
  "responseValues": [],
  "attributes": [
    {
      "name": "uid",
      "value": "<EL>attributes.get('uid').get(0)</EL>",
      "responseOfSubRequestId": null,
      "items": null,
      "subAttributes": []
    }
  ]
}

Suprimir API de cuenta

  • Nombre: suprimir API de cuenta
  • Método: DELETE
  • URL: <target-system>/admin/v1/Users/<EL>attributes.get('uid').get(0)</EL>
  • Cabeceras
    • Content-Type: application/json
    • Authorization: <<CREDENTIALS>>. El valor <<CREDENTIALS>> se resuelve en tiempo de ejecución mediante las credenciales introducidas por OCI Vault o por el usuario configuradas en la configuración de integración.
  • Parameter: forceDelete: true
  • Respuesta

    Utilice la siguiente respuesta:

    Name: uid
Value: <EL>attributes.get('uid').get(0)</EL>
    O bien, utilice el editor de JSON
    {
  "items": "",
  "responseValues": [],
  "attributes": [
    {
      "name": "uid",
      "value": "<EL>attributes.get('uid').get(0)</EL>",
      "responseOfSubRequestId": null,
      "items": null,
      "subAttributes": []
    }
  ]
}