All URIs are relative to /api
| Method | HTTP request | Description |
|---|---|---|
| V1SsoDependenciesGet | Get /v1/sso/dependencies | Retrieve the list of Enrollment Customizations using SSO |
| V1SsoDisablePost | Post /v1/sso/disable | Disable SSO |
| V1SsoGet | Get /v1/sso | Retrieve the current Single Sign On configuration settings |
| V1SsoHistoryGet | Get /v1/sso/history | Get SSO history object |
| V1SsoHistoryPost | Post /v1/sso/history | Add SSO history object notes |
| V1SsoMetadataDownloadGet | Get /v1/sso/metadata/download | Download the Jamf Pro SAML metadata file |
| V1SsoPut | Put /v1/sso | Updates the current Single Sign On configuration settings |
| V1SsoValidatePost | Post /v1/sso/validate | Endpoint for validation of a saml metadata url |
EnrollmentCustomizationDependencies V1SsoDependenciesGet(ctx).Execute()
Retrieve the list of Enrollment Customizations using SSO
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.SsoSettingsApi.V1SsoDependenciesGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SsoSettingsApi.V1SsoDependenciesGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `V1SsoDependenciesGet`: EnrollmentCustomizationDependencies
fmt.Fprintf(os.Stdout, "Response from `SsoSettingsApi.V1SsoDependenciesGet`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiV1SsoDependenciesGetRequest struct via the builder pattern
EnrollmentCustomizationDependencies
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1SsoDisablePost(ctx).Execute()
Disable SSO
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.SsoSettingsApi.V1SsoDisablePost(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SsoSettingsApi.V1SsoDisablePost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiV1SsoDisablePostRequest struct via the builder pattern
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SsoSettings V1SsoGet(ctx).Execute()
Retrieve the current Single Sign On configuration settings
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.SsoSettingsApi.V1SsoGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SsoSettingsApi.V1SsoGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `V1SsoGet`: SsoSettings
fmt.Fprintf(os.Stdout, "Response from `SsoSettingsApi.V1SsoGet`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiV1SsoGetRequest struct via the builder pattern
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
HistorySearchResults V1SsoHistoryGet(ctx).Page(page).PageSize(pageSize).Sort(sort).Filter(filter).Execute()
Get SSO history object
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
page := int32(56) // int32 | (optional) (default to 0)
pageSize := int32(56) // int32 | (optional) (default to 100)
sort := []string{"Inner_example"} // []string | Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc (optional) (default to ["id:desc"])
filter := "filter_example" // 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: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15 (optional) (default to "")
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.SsoSettingsApi.V1SsoHistoryGet(context.Background()).Page(page).PageSize(pageSize).Sort(sort).Filter(filter).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SsoSettingsApi.V1SsoHistoryGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `V1SsoHistoryGet`: HistorySearchResults
fmt.Fprintf(os.Stdout, "Response from `SsoSettingsApi.V1SsoHistoryGet`: %v\n", resp)
}Other parameters are passed through a pointer to a apiV1SsoHistoryGetRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| page | int32 | [default to 0] | |
| pageSize | int32 | [default to 100] | |
| sort | []string | Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc | [default to ["id:desc"]] |
| filter | 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: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15 | [default to ""] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
HrefResponse V1SsoHistoryPost(ctx).ObjectHistoryNote(objectHistoryNote).Execute()
Add SSO history object notes
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
objectHistoryNote := *openapiclient.NewObjectHistoryNote("A generic note can sometimes be useful, but generally not.") // ObjectHistoryNote | history notes to create
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.SsoSettingsApi.V1SsoHistoryPost(context.Background()).ObjectHistoryNote(objectHistoryNote).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SsoSettingsApi.V1SsoHistoryPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `V1SsoHistoryPost`: HrefResponse
fmt.Fprintf(os.Stdout, "Response from `SsoSettingsApi.V1SsoHistoryPost`: %v\n", resp)
}Other parameters are passed through a pointer to a apiV1SsoHistoryPostRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| objectHistoryNote | ObjectHistoryNote | history notes to create |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
*os.File V1SsoMetadataDownloadGet(ctx).Execute()
Download the Jamf Pro SAML metadata file
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.SsoSettingsApi.V1SsoMetadataDownloadGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SsoSettingsApi.V1SsoMetadataDownloadGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `V1SsoMetadataDownloadGet`: *os.File
fmt.Fprintf(os.Stdout, "Response from `SsoSettingsApi.V1SsoMetadataDownloadGet`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiV1SsoMetadataDownloadGetRequest struct via the builder pattern
- Content-Type: Not defined
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SsoSettings V1SsoPut(ctx).SsoSettings(ssoSettings).Execute()
Updates the current Single Sign On configuration settings
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
ssoSettings := *openapiclient.NewSsoSettings(false, false, false, false, false, false, "USERNAME", false, "GroupAttributeName_example", "GroupRdnKey_example", "ADFS", "saml/metadata", "URL") // SsoSettings |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.SsoSettingsApi.V1SsoPut(context.Background()).SsoSettings(ssoSettings).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SsoSettingsApi.V1SsoPut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `V1SsoPut`: SsoSettings
fmt.Fprintf(os.Stdout, "Response from `SsoSettingsApi.V1SsoPut`: %v\n", resp)
}Other parameters are passed through a pointer to a apiV1SsoPutRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| ssoSettings | SsoSettings |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1SsoValidatePost(ctx).SsoMetadataUrl(ssoMetadataUrl).Execute()
Endpoint for validation of a saml metadata url
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
ssoMetadataUrl := *openapiclient.NewSsoMetadataUrl("https://your-idp.com/saml/metadata") // SsoMetadataUrl | url to validate
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.SsoSettingsApi.V1SsoValidatePost(context.Background()).SsoMetadataUrl(ssoMetadataUrl).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SsoSettingsApi.V1SsoValidatePost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}Other parameters are passed through a pointer to a apiV1SsoValidatePostRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| ssoMetadataUrl | SsoMetadataUrl | url to validate |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]