Identity Broker REST API Reference

UnboundID Logo

/identityproviderdata

Mount Point: /auth/api/v1/identityproviderdata/

The following operations are supported on this resource:

GET

Retrieve a list of IdentityProviderData from the entire set of defined IdentityProviderData.

Parameters

name description type default
startIndex The index number of the first item to be provided in the results. A null value is equivalent to 0. query 0
count The maximum number of items to be provided in the results. A null value signifies no maximum. query
sortBy Specifies how the results should be sorted. Allowed values are EVALUATION_ORDER_ASCENDING. A null value returns items in an unspecified order. query EVALUATION_ORDER_ASCENDING
filterBy Specifies how filtering will occur. Allowed values are DESCRIPTION, ID, IDENTITY_PROVIDER_ID, DATA_VIEW_ID_EQUALITY, VERSION. query
filter user-supplied input used for filtering. query
excludesList comma-separated list of ids to exclude from results. query

Response Body

result: identityProviderData
media types: application/json

Paged results of all requested IdentityProviderData.

Status Codes

code description
200 Success

POST

Creates a model object.

Request Body

element: identityProviderData
media types: application/json

(no documentation provided)

Response Body

result: identityProviderData
media types: application/json

The created model object response.

Status Codes

code description
201 Success
400 Bad Request

PUT

Bulk update or create IdentityProviderData.

Request Body

element: (custom)
media types: application/json

A list of the IdentityProviderData to be updated or created.

Response Body

result: identityProviderData
media types: application/json

A list of the updated or created IdentityProviderData, in the same order as presented.

Status Codes

code description
200 Success
400 Bad Request
404 No such object