Skip to content

AccessRulesAPI.md

Latest commit

 

History

History
288 lines (178 loc) · 8.37 KB

AccessRulesAPI.md

File metadata and controls

288 lines (178 loc) · 8.37 KB
Raw

\AccessRulesAPI

All URIs are relative to https://api.opal.dev/v1

Method HTTP request Description
CreateAccessRule Post /access-rules
GetAccessRule Get /access-rules/{access_rule_id}
GetAccessRules Get /access-rules
UpdateAccessRule Put /access-rules/{access_rule_id}

CreateAccessRule

AccessRule CreateAccessRule(ctx).UpdateAccessRuleInfo(updateAccessRuleInfo).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/opalsecurity/opal-go"
)

func main() {
	updateAccessRuleInfo := *openapiclient.NewUpdateAccessRuleInfo("Platform Engineering", "This access rule represents all platform engineers in the company.", "7c86c85d-0651-43e2-a748-d69d658418e8", "ACTIVE", *openapiclient.NewRuleClauses(*openapiclient.NewRuleConjunction([]openapiclient.RuleDisjunction{*openapiclient.NewRuleDisjunction([]openapiclient.TagSelector{*openapiclient.NewTagSelector("Key_example", "Value_example", "ConnectionId_example")})}))) // UpdateAccessRuleInfo | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AccessRulesAPI.CreateAccessRule(context.Background()).UpdateAccessRuleInfo(updateAccessRuleInfo).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessRulesAPI.CreateAccessRule``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateAccessRule`: AccessRule
	fmt.Fprintf(os.Stdout, "Response from `AccessRulesAPI.CreateAccessRule`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
updateAccessRuleInfo UpdateAccessRuleInfo

Return type

AccessRule

Authorization

BearerAuth

HTTP request headers

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

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

GetAccessRule

AccessRule GetAccessRule(ctx, accessRuleId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/opalsecurity/opal-go"
)

func main() {
	accessRuleId := "1b978423-db0a-4037-a4cf-f79c60cb67b3" // string | The access rule ID (group ID) of the access rule.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AccessRulesAPI.GetAccessRule(context.Background(), accessRuleId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessRulesAPI.GetAccessRule``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetAccessRule`: AccessRule
	fmt.Fprintf(os.Stdout, "Response from `AccessRulesAPI.GetAccessRule`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accessRuleId string The access rule ID (group ID) of the access rule.

Other Parameters

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

Name Type Description Notes

Return type

AccessRule

Authorization

BearerAuth

HTTP request headers

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

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

GetAccessRules

PaginatedAccessRulesList GetAccessRules(ctx).Cursor(cursor).PageSize(pageSize).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/opalsecurity/opal-go"
)

func main() {
	cursor := "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" // string | The pagination cursor value. (optional)
	pageSize := int32(200) // int32 | Number of results to return per page. Default is 200. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AccessRulesAPI.GetAccessRules(context.Background()).Cursor(cursor).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessRulesAPI.GetAccessRules``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetAccessRules`: PaginatedAccessRulesList
	fmt.Fprintf(os.Stdout, "Response from `AccessRulesAPI.GetAccessRules`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
cursor string The pagination cursor value.
pageSize int32 Number of results to return per page. Default is 200.

Return type

PaginatedAccessRulesList

Authorization

BearerAuth

HTTP request headers

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

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

UpdateAccessRule

AccessRule UpdateAccessRule(ctx, accessRuleId).UpdateAccessRuleInfo(updateAccessRuleInfo).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/opalsecurity/opal-go"
)

func main() {
	accessRuleId := "1b978423-db0a-4037-a4cf-f79c60cb67b3" // string | The access rule ID (group ID) of the access rule.
	updateAccessRuleInfo := *openapiclient.NewUpdateAccessRuleInfo("Platform Engineering", "This access rule represents all platform engineers in the company.", "7c86c85d-0651-43e2-a748-d69d658418e8", "ACTIVE", *openapiclient.NewRuleClauses(*openapiclient.NewRuleConjunction([]openapiclient.RuleDisjunction{*openapiclient.NewRuleDisjunction([]openapiclient.TagSelector{*openapiclient.NewTagSelector("Key_example", "Value_example", "ConnectionId_example")})}))) // UpdateAccessRuleInfo | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AccessRulesAPI.UpdateAccessRule(context.Background(), accessRuleId).UpdateAccessRuleInfo(updateAccessRuleInfo).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessRulesAPI.UpdateAccessRule``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateAccessRule`: AccessRule
	fmt.Fprintf(os.Stdout, "Response from `AccessRulesAPI.UpdateAccessRule`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accessRuleId string The access rule ID (group ID) of the access rule.

Other Parameters

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

Name Type Description Notes

updateAccessRuleInfo | UpdateAccessRuleInfo | |

Return type

AccessRule

Authorization

BearerAuth

HTTP request headers

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

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