\PermissionSetApi

All URIs are relative to http://keyfactor.example.com

Method	HTTP request	Description
CreatePermissionSets	POST /PermissionSets	Creates a new permission set.
DeletePermissionSetsById	DELETE /PermissionSets/{id}	Deletes a permission set.
GetPermissionSets	GET /PermissionSets	Gets all Permission Set(s) in the system if the user has a security role that is assigned to the Global Permission Set and the security role has the Global Security Read permission. Otherwise, returns only the Permission Sets with the Security Modify permission that are assigned to the user's security role(s).
GetPermissionSetsById	GET /PermissionSets/{id}	Gets permission set data.
GetPermissionSetsMy	GET /PermissionSets/My
UpdatePermissionSets	PUT /PermissionSets

CreatePermissionSets

PermissionSetsPermissionSetResponse NewCreatePermissionSetsRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).PermissionSetsPermissionSetCreateRequest(permissionSetsPermissionSetCreateRequest).Execute()

Creates a new permission set.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)
    permissionSetsPermissionSetCreateRequest := *openapiclient.NewPermissionSetsPermissionSetCreateRequest("Name_example", []string{"Permissions_example"}) // PermissionSetsPermissionSetCreateRequest | Information about the new permission set. (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PermissionSetApi.NewCreatePermissionSetsRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).PermissionSetsPermissionSetCreateRequest(permissionSetsPermissionSetCreateRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PermissionSetApi.CreatePermissionSets``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreatePermissionSets`: PermissionSetsPermissionSetResponse
    fmt.Fprintf(os.Stdout, "Response from `PermissionSetApi.CreatePermissionSets`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreatePermissionSetsRequest struct via the builder pattern

Name	Type	Description
xKeyfactorRequestedWith	string	Type of the request [XMLHttpRequest, APIClient]
xKeyfactorApiVersion	string	Desired version of the api, if not provided defaults to v1
permissionSetsPermissionSetCreateRequest	PermissionSetsPermissionSetCreateRequest	Information about the new permission set.

Return type

PermissionSetsPermissionSetResponse

Authorization

basicAuth

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

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

DeletePermissionSetsById

NewDeletePermissionSetsByIdRequest(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Deletes a permission set.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | The id of the permission set to delete.
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PermissionSetApi.NewDeletePermissionSetsByIdRequest(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PermissionSetApi.DeletePermissionSetsById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The id of the permission set to delete.

Other Parameters

Other parameters are passed through a pointer to a apiDeletePermissionSetsByIdRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

GetPermissionSets

[]PermissionSetsPermissionSetResponse NewGetPermissionSetsRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).QueryString(queryString).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Gets all Permission Set(s) in the system if the user has a security role that is assigned to the Global Permission Set and the security role has the Global Security Read permission. Otherwise, returns only the Permission Sets with the Security Modify permission that are assigned to the user's security role(s).

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    queryString := "queryString_example" // string |  (optional)
    pageReturned := int32(56) // int32 |  (optional)
    returnLimit := int32(56) // int32 |  (optional)
    sortField := "sortField_example" // string |  (optional)
    sortAscending := openapiclient.Keyfactor.Common.QueryableExtensions.SortOrder(0) // KeyfactorCommonQueryableExtensionsSortOrder |  (optional)
    xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PermissionSetApi.NewGetPermissionSetsRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).QueryString(queryString).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PermissionSetApi.GetPermissionSets``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetPermissionSets`: []PermissionSetsPermissionSetResponse
    fmt.Fprintf(os.Stdout, "Response from `PermissionSetApi.GetPermissionSets`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetPermissionSetsRequest struct via the builder pattern

Name	Type	Description
xKeyfactorRequestedWith	string	Type of the request [XMLHttpRequest, APIClient]
queryString	string
pageReturned	int32
returnLimit	int32
sortField	string
sortAscending	KeyfactorCommonQueryableExtensionsSortOrder
xKeyfactorApiVersion	string	Desired version of the api, if not provided defaults to v1

Return type

[]PermissionSetsPermissionSetResponse

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

GetPermissionSetsById

PermissionSetsPermissionSetResponse NewGetPermissionSetsByIdRequest(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Gets permission set data.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PermissionSetApi.NewGetPermissionSetsByIdRequest(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PermissionSetApi.GetPermissionSetsById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetPermissionSetsById`: PermissionSetsPermissionSetResponse
    fmt.Fprintf(os.Stdout, "Response from `PermissionSetApi.GetPermissionSetsById`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string

Other Parameters

Other parameters are passed through a pointer to a apiGetPermissionSetsByIdRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

PermissionSetsPermissionSetResponse

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

GetPermissionSetsMy

[]CSSCMSDataModelModelsSecurityPermissionSet NewGetPermissionSetsMyRequest(ctx).AccessControlString(accessControlString).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accessControlString := "accessControlString_example" // string | The access control string to check within the user's security role's permission set(s).
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PermissionSetApi.NewGetPermissionSetsMyRequest(context.Background()).AccessControlString(accessControlString).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PermissionSetApi.GetPermissionSetsMy``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetPermissionSetsMy`: []CSSCMSDataModelModelsSecurityPermissionSet
    fmt.Fprintf(os.Stdout, "Response from `PermissionSetApi.GetPermissionSetsMy`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetPermissionSetsMyRequest struct via the builder pattern

Name	Type	Description
accessControlString	string	The access control string to check within the user's security role's permission set(s).
xKeyfactorRequestedWith	string	Type of the request [XMLHttpRequest, APIClient]
xKeyfactorApiVersion	string	Desired version of the api, if not provided defaults to v1

Return type

[]CSSCMSDataModelModelsSecurityPermissionSet

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

UpdatePermissionSets

PermissionSetsPermissionSetResponse NewUpdatePermissionSetsRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).PermissionSetsPermissionSetUpdateRequest(permissionSetsPermissionSetUpdateRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    permissionSetsPermissionSetUpdateRequest := *openapiclient.NewPermissionSetsPermissionSetUpdateRequest("Id_example", []string{"Permissions_example"}) // PermissionSetsPermissionSetUpdateRequest | 
    xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PermissionSetApi.NewUpdatePermissionSetsRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).PermissionSetsPermissionSetUpdateRequest(permissionSetsPermissionSetUpdateRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PermissionSetApi.UpdatePermissionSets``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdatePermissionSets`: PermissionSetsPermissionSetResponse
    fmt.Fprintf(os.Stdout, "Response from `PermissionSetApi.UpdatePermissionSets`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUpdatePermissionSetsRequest struct via the builder pattern

Name	Type	Description
xKeyfactorRequestedWith	string	Type of the request [XMLHttpRequest, APIClient]
permissionSetsPermissionSetUpdateRequest	PermissionSetsPermissionSetUpdateRequest
xKeyfactorApiVersion	string	Desired version of the api, if not provided defaults to v1

Return type

PermissionSetsPermissionSetResponse

Authorization

basicAuth

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

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

Uh oh!

FilesExpand file tree

PermissionSetApi.md

Latest commit

History

PermissionSetApi.md

File metadata and controls

\PermissionSetApi

CreatePermissionSets

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeletePermissionSetsById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetPermissionSets

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetPermissionSetsById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetPermissionSetsMy

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdatePermissionSets

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers