RapidIdentity Product Guide: Legacy UI

RESTPoints Method Fields

The configurable fields available to edit are based the Method/Path (i.e. the HTTP verb) selected.

Field

Description

Notes

Enabled

Click the checkbox to enable the RESTPoint.

Description

An optional description for the RESTPoint.

HTTP Method

Required. The method the RESTPoint will use.

Supported methods: GET; DELETE; HEAD; OPTIONS; PUT; PATCH; and POST

Path

Required. The path must start with a forward slash and may contain one or more path parameter placeholders in the form of {name} as described by the @Path annotation in the JAX-RS API.

The combination of the Method and Path must be unique within the project.

Authentication

The default authentication is the same as the project, however, the default authentication can be overridden on a specific RESTPoint.

Each enabled RESTPoint must have at least one authentication method defined.

Produces

The MIME media type that the RESTPoint will return in the REST Response.

The available MIME media types are: application/json, application/xml, text/xml, text/plain, text/csv, text/html, application/octet-stream application/x-www-form-urlencoded

Consumes

The MIME media type that the RESTPoint expects as the content of the REST Request.

This field is only enabled for PUT, PATCH, and POST methods.

Action Set

Required. The Action Set to which the RESTPoint maps.

Input Properties

This table is populated automatically based on the existing Action Set called in the RESTPoint configuration.

The Property column reflects the Action Set input property and is not editable.

The type column reflects the defined input property type initially but is editable. The available types are ARRAY, BOOLEAN, NUMBER, BYTES, OBJECT, STRING, and XML.

The Source column is the location from which the input parameter originates. If Source is left blank, then the value passed to the Action Set for that input property will be undefined. There are thirteen possible sources.

  • CONTENT: data comes from the content of a PUT, PATCH, or POST method

  • COOKIE: data comes from the content of the cookie named by the Source Name column

  • COOKIES: data is an object containing all the cookies defined in the request

    • Type column should always be set to OBJECT

  • FORM: data comes from the content of form data content of a PUT, PATH, or POST method

    • Consumes field usually should be set to application/x-www-form-urlencoded or multipart/form-data

    • Type column should always be OBJECT

  • FORM_PARAM: data comes from the content of the form field named by the Source Name column

    • Consumes field usually should be set to application/x-www-form-urlencoded or multipart/form-data

    • Type column should be ARRAY if more than one field with that name is expected

  • HEADER: data comes from the content of the REST Request header named by the Source Name column

    • Type column should be ARRAY if more than one header with that name is expected

  • HEADERS: data is an object with the values of all headers in the REST Request

    • Type column should always be set to OBJECT

  • METHOD: data is the REST Request method

  • PATH: data is the REST Request complete path

  • PATH_PARAM: data comes from path parameter named by the Source Name column

    • A corresponding placeholder must be defined in the Path field

  • QUERY_PARAM: data comes from REST Request query parameter named by the Source Name column

    • Type column should be ARRAY if more than one query parameter with that name is expected

  • QUERY_PARAMS: data is an object with the values of all query parameters in the REST Request

    • Type column should always be set to OBJECT

  • STATIC_VALUE: data is a static value from the Name/Value