GuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Export Cloud Identity Providers collection

post
https://yourServer.jamfcloud.com/api/v1/cloud-idp/export

Export Cloud Identity Providers collection

Query Params
export-fields
array of strings
Defaults to

Export fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username

export-fields
export-labels
array of strings
Defaults to

Export labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username

export-labels
integer
Defaults to 0
integer
Defaults to 100
sort
array of strings
Defaults to id:asc

Sorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be seperated with a comma. Example: sort=id:desc,name:asc

sort
string

Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name. This param can be combined with paging and sorting. Example: name=="department"

Body Params

Optional. Override query parameters since they can make URI exceed 2,000 character limit.

integer | null
Defaults to 0
integer | null
Defaults to 100
sort
array of strings | null
Defaults to id:desc

Sorting criteria in the format: [[:asc/desc]. Default direction when not stated is ascending.

sort
string | null
fields
array of objects | null

Used to change default order or ignore some of the fields. When null or empty array, all fields will be exported.

fields
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 months ago

Language
Credentials
Response 
 Choose an example:
text/csv
application/json
Updated 2 months ago