Skip to content

Latest commit

 

History

History
95 lines (65 loc) · 4.22 KB

PolicytemplatesApi.md

File metadata and controls

95 lines (65 loc) · 4.22 KB

\PolicytemplatesApi

All URIs are relative to https://console.jumpcloud.com/api/v2

Method HTTP request Description
PolicytemplatesGet Get /policytemplates/{id} Get a specific Policy Template
PolicytemplatesList Get /policytemplates Lists all of the Policy Templates

PolicytemplatesGet

PolicyTemplateWithDetails PolicytemplatesGet(ctx, id, contentType, accept, optional) Get a specific Policy Template

This endpoint returns a specific policy template. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string ObjectID of the Policy Template.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
id string ObjectID of the Policy Template.
contentType string [default to application/json]
accept string [default to application/json]
xOrgId string [default to ]

Return type

PolicyTemplateWithDetails

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PolicytemplatesList

[]PolicyTemplate PolicytemplatesList(ctx, contentType, accept, optional) Lists all of the Policy Templates

This endpoint returns all policy templates. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/policytemplates \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
contentType string [default to application/json]
accept string [default to application/json]
fields []string The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.
filter []string Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
limit int32 The number of records to return at once. Limited to 100. [default to 10]
skip int32 The offset into the records to return. [default to 0]
sort []string The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.
xOrgId string [default to ]

Return type

[]PolicyTemplate

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]