Get OpenAPI description for a secure service

Retrieve the OpenAPI description from a secure RESTful service by obtaining an access token and including it in the service URL.

Secure RESTful services require an access token before you can retrieve the OpenAPI description. Use the GetToken tool to obtain the token, then include it in the Web service URL.

  1. Use the GetToken tool to obtain an access token.
    
    GetToken password -u user -p mypw --idp https://host:port/gas/ws/r/services/GeneroIdentityProvider --savetofile mytoken.json myWSScope
    

    The token is saved to mytoken.json.

    The token is valid for a limited time (for example, 10 minutes).

  2. Add the token to the Web service URL to retrieve the OpenAPI description.
    http://host:port/gas/ws/r/group/xcf/service?openapi.json&access_token=token

    The OpenAPI description is displayed in JSON format in your browser. You can save the output to a file if needed.

  3. (Optional) Save the OpenAPI description to a file for later use.

    After retrieving the description, you can generate the REST stub file. See Generate a REST stub filet.