Foro en Español

Reply
Contributor I

Duda con API Explorer

Hola a todos

 

Ante todo comento que no soy programador, pero quiero aprender a hacer cosillas con la "API Explorer" del Clearpass. Hasta ahora solo he logrado obtener el token.

Alguien sabe donde hay ejemplos de usos que se le dan a esta rest API para poderlos utilizar como guía. He descargado algunos manuales, que casi todos utilizan la herramienta "curl" y hay ejemplos. pero no encuentro ejemplos de uso del la Api explorer del clearpass.

 

Saludos

Aruba Employee

Re: Duda con API Explorer

La API Explorer de ClearPass te guía sobre las opciones disponibles para explotar dicha API. En este caso, deberás entrar en la URL correspondiente que será de este tipo:

https://<ip-del-ClearPass>/api-docs/

Seleccionas ahí qué opción quieres explotar del ClearPass a través de la API:Screen Shot 2018-01-24 at 07.46.38.png

 

Entrando en cualquier opción, verás una pantalla como la siguiente (en este caso de ejemplo hacemos click en GuestManager):Pasted_Image_24_01_2018__07_48.png

 

En el campo Authorization pegas el Token que hayas generado en el ClearPass de tipo Bearer.  Puedes por ejemplo extender el menú /guest y vamos a sacar el listado de usuarios invitados que estén dados de alta. Bastará con pulsar e botón "Try It out!" y verás como aparece el resultado de la consulta vía API en el campo "Response Body":Screen Shot 2018-01-24 at 07.51.18.png

 

Con toda esta información que aparece ahí puedes saber como funciona la API y los datos posibles para filtrado que aparecen en cada tipo de consulta API.

Por ejemplo, en el caso anterior podemos filtrar los usuarios Guest por cualquier campo indicado en la API:

Guest {
create_time (string, optional): Time at which the account was created,
current_state (string, optional) = ['active' or 'disabled' or 'expired' or 'pending']: Read-only property indicating the current state of the account,
do_expire (integer, optional): Action to take when the expire_time is reached,
email (string, optional): Email address for the account,
enabled (boolean, optional): Flag indicating if the account is enabled,
expire_time (string, optional): Time at which the account will expire,
id (integer, optional): Numeric ID of the guest account,
mac (string, optional): MAC address of the guest’s device,
notes (string, optional): Comments or notes stored with the account,
password (string, optional): Password for the account,
role_id (integer, optional): Role to assign to the account,
simultaneous_use (integer, optional): Number of simultaneous sessions allowed for the account,
sponsor_email (string, optional): Email address of the sponsor,
sponsor_name (string, optional): Name of the sponsor of the account,
start_time (string, optional): Time at which the account will be enabled,
username (string, optional): Username of the account,
visitor_company (string, optional): The guest’s company name,
visitor_name (string, optional): The guest’s contact telephone number,
... (string, optional): Additional properties (custom fields) may be stored with the account
}

Para ello, en el campo "filter" podemos indicar un "visitor_name" incluyendo este campo y ejecutando la API de nuevo:

Pasted_Image_24_01_2018__07_55.png

Una vez que ya tienes información sobre como explotar dicha API, puedes generar tu propia conexión con el lenguaje que programación que necesites. En muchos casos como indicas, se hacen consultas externas mediante CURL contra el ClearPass usando el detalle que has podido verificar a través del API-Explorer.


Rafael del Cerro Flores
ACMP, ACCP, ACDX#324, ACCX#711
Contributor I

Re: Duda con API Explorer

Muchas gracias Rafael. Esto es lo que me hacia falta.

 

saludos

MVP

Re: Duda con API Explorer

Hola Rafa,

Aprovechando el hilo, al hacer la petición para obtener datos de Guest, el campo Password es opcional.

He intentado obtenerlo con un script junto con el username pero imagino que algún parámetro adicional debe ser activado para obtenerlo en el query.

Incluso desde el UI no consigo ver ese parámetro.

Sabes como activar/obtener ese parámetro a través de la API.

Gracias
Un saludo
Regards,
Borja
ACMX #567 //ACCP//CWNA//CWAP
Aruba Employee

Re: Duda con API Explorer

No entiendo qué necesitas obtener concretamente ¿podrías ayudarme a entenderlo mejor?

Por otro lado, ¿te refieres a sacar el dato por la API o por otro lado?

Gracias


Rafael del Cerro Flores
ACMP, ACCP, ACDX#324, ACCX#711
MVP

Re: Duda con API Explorer

Disculpa que no me he explicado bien.

 

En el ejemplo que dabas de Guest puedes sacar el listado de todos los usuarios que esten en la base de datos de Guest como bien decias.

 

Por ejemplo: para uno de los usuarios que hay en el database obtengo:

 

    "items": [
      {
        "id": "3006",
        "username": "test@api.test",
        "start_time": 1515774141,
        "expire_time": 1518366141,
        "sponsor_name": "admin",
        "sponsor_profile": "1",
        "enabled": true,
        "current_state": "active",
        "notes": "test api",
        "visitor_carrier": null,
        "role_name": "xxxxx",
        "role_id": 4,
        "email": "test@api.test",
        "source": "create_user",
        "do_expire": "1",
        "create_time": 1515774117,
        "remote_addr": "10.10.10.10",
        "visitor_company": "borja test api",
        "visitor_name": "test",
        "expire_postlogin": "0",
        "simultaneous_use": "1",
        "sponsor_profile_name": "Super Administrator",
        "expired_notify_status": "1",
        "_links": {
          "self": {
            "href": "https://10.10.130.201/api/guest/3006"
          }
        }
      },

Para ese usuario esta mostrando varios campos: "username", "id", "start_time", etc.

 

My pregunta es: Puedo obtener tambien el campo "Password" de alguna forma?

 

Espero haberme explicado mejor!

 

Gracias,

Un saludo

 

 

 

 

Regards,
Borja
ACMX #567 //ACCP//CWNA//CWAP
Aruba Employee

Re: Duda con API Explorer

Por diseño, no se puede obtener la password creada. Puedes crear una password nuevo, pero me temo que no recuperarla.


Rafael del Cerro Flores
ACMP, ACCP, ACDX#324, ACCX#711
MVP

Re: Duda con API Explorer

OK, gracias. Pense que se podia obtener tambien de alguna forma.

Un saludo
Regards,
Borja
ACMX #567 //ACCP//CWNA//CWAP
Search Airheads
cancel
Showing results for 
Search instead for 
Did you mean: