openapi

package
v1.2.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 2, 2025 License: MIT Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient

type APIClient struct {

	// API Services
	APIKeysApi               *APIKeysApiService
	AuthenticationApi        *AuthenticationApiService
	ConditionSetRulesApi     *ConditionSetRulesApiService
	ConditionSetsApi         *ConditionSetsApiService
	DecisionLogsApi          *DecisionLogsApiService
	DecisionLogsIngressApi   *DecisionLogsIngressApiService
	DefaultApi               *DefaultApiService
	ElementsConfigsApi       *ElementsConfigsApiService
	ElementsDataApi          *ElementsDataApiService
	EnvironmentsApi          *EnvironmentsApiService
	ImplicitGrantsApi        *ImplicitGrantsAPIService
	InstructionsApi          *InstructionsApiService
	MembersApi               *MembersApiService
	OPALDataApi              *OPALDataApiService
	OrganizationsApi         *OrganizationsApiService
	PolicyApi                *PolicyApiService
	PolicyDecisionPointsApi  *PolicyDecisionPointsApiService
	PolicyGitRepositoriesApi *PolicyGitRepositoriesApiService
	ProjectsApi              *ProjectsApiService
	ProxyConfigAPI           *ProxyConfigAPIService
	RelationshipTuplesApi    *RelationshipTuplesAPIService
	ResourceActionGroupsApi  *ResourceActionGroupsApiService
	ResourceActionsApi       *ResourceActionsApiService
	ResourceAttributesApi    *ResourceAttributesApiService
	ResourceInstancesApi     *ResourceInstancesApiService
	ResourceRelations        *ResourceRelationsAPIService
	ResourceRoles            *ResourceRolesApiService
	ResourcesApi             *ResourcesApiService
	RoleAssignmentsApi       *RoleAssignmentsApiService
	RolesApi                 *RolesApiService
	TenantsApi               *TenantsApiService
	UserAttributesApi        *UserAttributesApiService
	UsersApi                 *UsersApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Permit.io API API v2.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIKeysApiService

type APIKeysApiService service

APIKeysApiService APIKeysApi service

func (*APIKeysApiService) CreateApiKey

CreateApiKey Create Api Key

Creates a new api_key under the active organization.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCreateApiKeyRequest

func (*APIKeysApiService) CreateApiKeyExecute

Execute executes the request

@return APIKeyRead

func (*APIKeysApiService) DeleteApiKey

func (a *APIKeysApiService) DeleteApiKey(ctx context.Context, apiKeyId string) ApiDeleteApiKeyRequest

DeleteApiKey Delete Api Key

Deletes the api_key and all its related data.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param apiKeyId The unique id of the API key
@return ApiDeleteApiKeyRequest

func (*APIKeysApiService) DeleteApiKeyExecute

func (a *APIKeysApiService) DeleteApiKeyExecute(r ApiDeleteApiKeyRequest) (*http.Response, error)

Execute executes the request

func (*APIKeysApiService) GetApiKey

func (a *APIKeysApiService) GetApiKey(ctx context.Context, apiKeyId string) ApiGetApiKeyRequest

GetApiKey Get Api Key

Gets a single api_key matching the given api_key_id, if such api_key exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param apiKeyId The unique id of the API key
@return ApiGetApiKeyRequest

func (*APIKeysApiService) GetApiKeyExecute

Execute executes the request

@return APIKeyRead

func (*APIKeysApiService) GetApiKeyScope

GetApiKeyScope Get Api Key Scope

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetApiKeyScopeRequest

func (*APIKeysApiService) GetApiKeyScopeExecute

Execute executes the request

@return APIKeyScopeRead

func (*APIKeysApiService) GetEnvironmentApiKey

func (a *APIKeysApiService) GetEnvironmentApiKey(ctx context.Context, projId string, envId string) ApiGetEnvironmentApiKeyRequest

GetEnvironmentApiKey Get Environment Api Key

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiGetEnvironmentApiKeyRequest

func (*APIKeysApiService) GetEnvironmentApiKeyExecute

func (a *APIKeysApiService) GetEnvironmentApiKeyExecute(r ApiGetEnvironmentApiKeyRequest) (*models.APIKeyRead, *http.Response, error)

Execute executes the request

@return APIKeyRead

func (*APIKeysApiService) ListApiKeys

ListApiKeys List Api Keys

Lists all the api_keys under the active organization.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiListApiKeysRequest

func (*APIKeysApiService) ListApiKeysExecute

Execute executes the request

@return PaginatedResultAPIKeyRead

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiActivatePolicyRepoRequest

type ApiActivatePolicyRepoRequest struct {
	ApiService *PolicyGitRepositoriesApiService
	// contains filtered or unexported fields
}

func (ApiActivatePolicyRepoRequest) Execute

type ApiAddParentResourceRoleRequest

type ApiAddParentResourceRoleRequest struct {
	ApiService *ResourceRolesApiService
	// contains filtered or unexported fields
}

func (ApiAddParentResourceRoleRequest) Execute

func (ApiAddParentResourceRoleRequest) PermitSession added in v1.0.5

type ApiAddParentRoleRequest

type ApiAddParentRoleRequest struct {
	ApiService *RolesApiService
	// contains filtered or unexported fields
}

func (ApiAddParentRoleRequest) Execute

type ApiAssignPermissionsToResourceRoleRequest

type ApiAssignPermissionsToResourceRoleRequest struct {
	ApiService *ResourceRolesApiService
	// contains filtered or unexported fields
}

func (ApiAssignPermissionsToResourceRoleRequest) AddRolePermissions

func (ApiAssignPermissionsToResourceRoleRequest) Execute

func (ApiAssignPermissionsToResourceRoleRequest) PermitSession added in v1.0.5

type ApiAssignPermissionsToRoleRequest

type ApiAssignPermissionsToRoleRequest struct {
	ApiService *RolesApiService
	// contains filtered or unexported fields
}

func (ApiAssignPermissionsToRoleRequest) AddRolePermissions

func (ApiAssignPermissionsToRoleRequest) Execute

type ApiAssignRoleRequest

type ApiAssignRoleRequest struct {
	ApiService *RoleAssignmentsApiService
	// contains filtered or unexported fields
}

func (ApiAssignRoleRequest) Execute

func (ApiAssignRoleRequest) PermitSession added in v1.0.5

func (r ApiAssignRoleRequest) PermitSession(permitSession string) ApiAssignRoleRequest

func (ApiAssignRoleRequest) RoleAssignmentCreate

func (r ApiAssignRoleRequest) RoleAssignmentCreate(roleAssignmentCreate models.RoleAssignmentCreate) ApiAssignRoleRequest

type ApiAssignRoleToUserRequest

type ApiAssignRoleToUserRequest struct {
	ApiService *UsersApiService
	// contains filtered or unexported fields
}

func (ApiAssignRoleToUserRequest) Execute

func (ApiAssignRoleToUserRequest) UserRoleCreate

type ApiAssignSetPermissionsRequest

type ApiAssignSetPermissionsRequest struct {
	ApiService *ConditionSetRulesApiService
	// contains filtered or unexported fields
}

func (ApiAssignSetPermissionsRequest) ConditionSetRuleCreate

func (r ApiAssignSetPermissionsRequest) ConditionSetRuleCreate(conditionSetRuleCreate models.ConditionSetRuleCreate) ApiAssignSetPermissionsRequest

func (ApiAssignSetPermissionsRequest) Execute

type ApiBulkAssignRoleRequest added in v0.0.10

type ApiBulkAssignRoleRequest struct {
	ApiService *RoleAssignmentsApiService
	// contains filtered or unexported fields
}

func (ApiBulkAssignRoleRequest) Execute added in v0.0.10

func (ApiBulkAssignRoleRequest) PermitSession added in v1.0.5

func (r ApiBulkAssignRoleRequest) PermitSession(permitSession string) ApiBulkAssignRoleRequest

func (ApiBulkAssignRoleRequest) RoleAssignmentCreate added in v0.0.10

func (r ApiBulkAssignRoleRequest) RoleAssignmentCreate(roleAssignmentCreate []models.RoleAssignmentCreate) ApiBulkAssignRoleRequest

type ApiBulkCreateRelationshipTuplesRequest added in v1.0.5

type ApiBulkCreateRelationshipTuplesRequest struct {
	ApiService *RelationshipTuplesAPIService
	// contains filtered or unexported fields
}

func (ApiBulkCreateRelationshipTuplesRequest) Execute added in v1.0.5

func (r ApiBulkCreateRelationshipTuplesRequest) Execute() (map[string]interface{}, *http.Response, error)

func (ApiBulkCreateRelationshipTuplesRequest) PermitSession added in v1.0.5

func (ApiBulkCreateRelationshipTuplesRequest) RelationshipTupleCreateBulkOperation added in v1.0.5

func (r ApiBulkCreateRelationshipTuplesRequest) RelationshipTupleCreateBulkOperation(relationshipTupleCreateBulkOperation models.RelationshipTupleCreateBulkOperation) ApiBulkCreateRelationshipTuplesRequest

type ApiBulkDeleteRelationshipTuplesRequest added in v1.0.5

type ApiBulkDeleteRelationshipTuplesRequest struct {
	ApiService *RelationshipTuplesAPIService
	// contains filtered or unexported fields
}

func (ApiBulkDeleteRelationshipTuplesRequest) Execute added in v1.0.5

func (r ApiBulkDeleteRelationshipTuplesRequest) Execute() (map[string]interface{}, *http.Response, error)

func (ApiBulkDeleteRelationshipTuplesRequest) PermitSession added in v1.0.5

func (ApiBulkDeleteRelationshipTuplesRequest) RelationshipTupleDeleteBulkOperation added in v1.0.5

func (r ApiBulkDeleteRelationshipTuplesRequest) RelationshipTupleDeleteBulkOperation(relationshipTupleDeleteBulkOperation models.RelationshipTupleDeleteBulkOperation) ApiBulkDeleteRelationshipTuplesRequest

type ApiBulkUnassignRoleRequest added in v0.0.10

type ApiBulkUnassignRoleRequest struct {
	ApiService *RoleAssignmentsApiService
	// contains filtered or unexported fields
}

func (ApiBulkUnassignRoleRequest) Execute added in v0.0.10

func (ApiBulkUnassignRoleRequest) PermitSession added in v1.0.5

func (r ApiBulkUnassignRoleRequest) PermitSession(permitSession string) ApiBulkUnassignRoleRequest

func (ApiBulkUnassignRoleRequest) RoleAssignmentRemove added in v0.0.10

func (r ApiBulkUnassignRoleRequest) RoleAssignmentRemove(roleAssignmentRemove []models.RoleAssignmentRemove) ApiBulkUnassignRoleRequest

type ApiCancelInviteRequest

type ApiCancelInviteRequest struct {
	ApiService *OrganizationsApiService
	// contains filtered or unexported fields
}

func (ApiCancelInviteRequest) Execute

func (r ApiCancelInviteRequest) Execute() (*http.Response, error)

type ApiCopyEnvironmentRequest added in v0.0.10

type ApiCopyEnvironmentRequest struct {
	ApiService *EnvironmentsApiService
	// contains filtered or unexported fields
}

func (ApiCopyEnvironmentRequest) EnvironmentCopy added in v0.0.10

func (ApiCopyEnvironmentRequest) Execute added in v0.0.10

type ApiCreateApiKeyRequest

type ApiCreateApiKeyRequest struct {
	ApiService *APIKeysApiService
	// contains filtered or unexported fields
}

func (ApiCreateApiKeyRequest) APIKeyCreate

func (ApiCreateApiKeyRequest) Execute

type ApiCreateConditionSetRequest

type ApiCreateConditionSetRequest struct {
	ApiService *ConditionSetsApiService
	// contains filtered or unexported fields
}

func (ApiCreateConditionSetRequest) ConditionSetCreate

func (ApiCreateConditionSetRequest) Execute

type ApiCreateElementsConfigRequest

type ApiCreateElementsConfigRequest struct {
	ApiService *ElementsConfigsApiService
	// contains filtered or unexported fields
}

func (ApiCreateElementsConfigRequest) ElementsConfigCreate

func (ApiCreateElementsConfigRequest) Execute

type ApiCreateEnvironmentRequest

type ApiCreateEnvironmentRequest struct {
	ApiService *EnvironmentsApiService
	// contains filtered or unexported fields
}

func (ApiCreateEnvironmentRequest) EnvironmentCreate

func (ApiCreateEnvironmentRequest) Execute

type ApiCreateImplicitGrantRequest added in v1.0.5

type ApiCreateImplicitGrantRequest struct {
	ApiService *ImplicitGrantsAPIService
	// contains filtered or unexported fields
}

func (ApiCreateImplicitGrantRequest) DerivedRoleRuleCreate added in v1.0.5

func (r ApiCreateImplicitGrantRequest) DerivedRoleRuleCreate(derivedRoleRuleCreate models.DerivedRoleRuleCreate) ApiCreateImplicitGrantRequest

func (ApiCreateImplicitGrantRequest) Execute added in v1.0.5

func (ApiCreateImplicitGrantRequest) PermitSession added in v1.0.5

type ApiCreateOrganizationRequest

type ApiCreateOrganizationRequest struct {
	ApiService *OrganizationsApiService
	// contains filtered or unexported fields
}

func (ApiCreateOrganizationRequest) Execute

func (ApiCreateOrganizationRequest) OrganizationCreate

type ApiCreatePolicyRepoRequest

type ApiCreatePolicyRepoRequest struct {
	ApiService *PolicyGitRepositoriesApiService
	// contains filtered or unexported fields
}

func (ApiCreatePolicyRepoRequest) Execute

func (ApiCreatePolicyRepoRequest) PolicyRepoCreate

type ApiCreateProjectRequest

type ApiCreateProjectRequest struct {
	ApiService *ProjectsApiService
	// contains filtered or unexported fields
}

func (ApiCreateProjectRequest) Execute

func (ApiCreateProjectRequest) ProjectCreate

type ApiCreateProxyConfigRequest added in v1.0.1

type ApiCreateProxyConfigRequest struct {
	ApiService *ProxyConfigAPIService
	// contains filtered or unexported fields
}

func (ApiCreateProxyConfigRequest) Execute added in v1.0.1

func (ApiCreateProxyConfigRequest) ProxyConfigCreate added in v1.0.1

type ApiCreateRelationshipTupleRequest added in v1.0.5

type ApiCreateRelationshipTupleRequest struct {
	ApiService *RelationshipTuplesAPIService
	// contains filtered or unexported fields
}

func (ApiCreateRelationshipTupleRequest) Execute added in v1.0.5

func (ApiCreateRelationshipTupleRequest) PermitSession added in v1.0.5

func (ApiCreateRelationshipTupleRequest) RelationshipTupleCreate added in v1.0.5

type ApiCreateResourceActionGroupRequest added in v0.0.10

type ApiCreateResourceActionGroupRequest struct {
	ApiService *ResourceActionGroupsApiService
	// contains filtered or unexported fields
}

func (ApiCreateResourceActionGroupRequest) Execute added in v0.0.10

func (ApiCreateResourceActionGroupRequest) ResourceActionGroupCreate added in v0.0.10

type ApiCreateResourceActionRequest

type ApiCreateResourceActionRequest struct {
	ApiService *ResourceActionsApiService
	// contains filtered or unexported fields
}

func (ApiCreateResourceActionRequest) Execute

func (ApiCreateResourceActionRequest) ResourceActionCreate

type ApiCreateResourceAttributeRequest

type ApiCreateResourceAttributeRequest struct {
	ApiService *ResourceAttributesApiService
	// contains filtered or unexported fields
}

func (ApiCreateResourceAttributeRequest) Execute

func (ApiCreateResourceAttributeRequest) ResourceAttributeCreate

type ApiCreateResourceInstanceRequest

type ApiCreateResourceInstanceRequest struct {
	ApiService *ResourceInstancesApiService
	// contains filtered or unexported fields
}

func (ApiCreateResourceInstanceRequest) Execute

func (ApiCreateResourceInstanceRequest) PermitSession added in v1.0.5

func (ApiCreateResourceInstanceRequest) ResourceInstanceCreate

type ApiCreateResourceRelationRequest added in v1.0.5

type ApiCreateResourceRelationRequest struct {
	ApiService *ResourceRelationsAPIService
	// contains filtered or unexported fields
}

func (ApiCreateResourceRelationRequest) Execute added in v1.0.5

func (ApiCreateResourceRelationRequest) PermitSession added in v1.0.5

func (ApiCreateResourceRelationRequest) RelationCreate added in v1.0.5

type ApiCreateResourceRequest

type ApiCreateResourceRequest struct {
	ApiService *ResourcesApiService
	// contains filtered or unexported fields
}

func (ApiCreateResourceRequest) Execute

func (ApiCreateResourceRequest) ResourceCreate

type ApiCreateResourceRoleRequest

type ApiCreateResourceRoleRequest struct {
	ApiService *ResourceRolesApiService
	// contains filtered or unexported fields
}

func (ApiCreateResourceRoleRequest) Execute

func (ApiCreateResourceRoleRequest) PermitSession added in v1.0.5

func (r ApiCreateResourceRoleRequest) PermitSession(permitSession string) ApiCreateResourceRoleRequest

func (ApiCreateResourceRoleRequest) ResourceRoleCreate

type ApiCreateRoleRequest

type ApiCreateRoleRequest struct {
	ApiService *RolesApiService
	// contains filtered or unexported fields
}

func (ApiCreateRoleRequest) Execute

func (ApiCreateRoleRequest) RoleCreate

type ApiCreateTenantRequest

type ApiCreateTenantRequest struct {
	ApiService *TenantsApiService
	// contains filtered or unexported fields
}

func (ApiCreateTenantRequest) Execute

func (ApiCreateTenantRequest) TenantCreate

type ApiCreateUserAttributeRequest

type ApiCreateUserAttributeRequest struct {
	ApiService *UserAttributesApiService
	// contains filtered or unexported fields
}

func (ApiCreateUserAttributeRequest) Execute

func (ApiCreateUserAttributeRequest) ResourceAttributeCreate

func (r ApiCreateUserAttributeRequest) ResourceAttributeCreate(resourceAttributeCreate models.ResourceAttributeCreate) ApiCreateUserAttributeRequest

func (ApiCreateUserAttributeRequest) ResourceId

type ApiCreateUserRequest

type ApiCreateUserRequest struct {
	ApiService *UsersApiService
	// contains filtered or unexported fields
}

func (ApiCreateUserRequest) Execute

func (ApiCreateUserRequest) UserCreate

type ApiDeleteApiKeyRequest

type ApiDeleteApiKeyRequest struct {
	ApiService *APIKeysApiService
	// contains filtered or unexported fields
}

func (ApiDeleteApiKeyRequest) Execute

func (r ApiDeleteApiKeyRequest) Execute() (*http.Response, error)

type ApiDeleteConditionSetRequest

type ApiDeleteConditionSetRequest struct {
	ApiService *ConditionSetsApiService
	// contains filtered or unexported fields
}

func (ApiDeleteConditionSetRequest) Execute

type ApiDeleteElementsConfigRequest

type ApiDeleteElementsConfigRequest struct {
	ApiService *ElementsConfigsApiService
	// contains filtered or unexported fields
}

func (ApiDeleteElementsConfigRequest) Execute

type ApiDeleteEnvironmentRequest

type ApiDeleteEnvironmentRequest struct {
	ApiService *EnvironmentsApiService
	// contains filtered or unexported fields
}

func (ApiDeleteEnvironmentRequest) Execute

type ApiDeleteImplicitGrantRequest added in v1.0.5

type ApiDeleteImplicitGrantRequest struct {
	ApiService *ImplicitGrantsAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteImplicitGrantRequest) DerivedRoleRuleDelete added in v1.0.5

func (r ApiDeleteImplicitGrantRequest) DerivedRoleRuleDelete(derivedRoleRuleDelete models.DerivedRoleRuleDelete) ApiDeleteImplicitGrantRequest

func (ApiDeleteImplicitGrantRequest) Execute added in v1.0.5

func (ApiDeleteImplicitGrantRequest) PermitSession added in v1.0.5

type ApiDeleteOrganizationMemberRequest

type ApiDeleteOrganizationMemberRequest struct {
	ApiService *MembersApiService
	// contains filtered or unexported fields
}

func (ApiDeleteOrganizationMemberRequest) Execute

type ApiDeleteOrganizationRequest

type ApiDeleteOrganizationRequest struct {
	ApiService *OrganizationsApiService
	// contains filtered or unexported fields
}

func (ApiDeleteOrganizationRequest) Execute

type ApiDeletePolicyRepoRequest

type ApiDeletePolicyRepoRequest struct {
	ApiService *PolicyGitRepositoriesApiService
	// contains filtered or unexported fields
}

func (ApiDeletePolicyRepoRequest) Execute

type ApiDeleteProjectRequest

type ApiDeleteProjectRequest struct {
	ApiService *ProjectsApiService
	// contains filtered or unexported fields
}

func (ApiDeleteProjectRequest) Execute

func (r ApiDeleteProjectRequest) Execute() (*http.Response, error)

type ApiDeleteProxyConfigRequest added in v1.0.1

type ApiDeleteProxyConfigRequest struct {
	ApiService *ProxyConfigAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteProxyConfigRequest) Execute added in v1.0.1

type ApiDeleteRelationshipTupleRequest added in v1.0.5

type ApiDeleteRelationshipTupleRequest struct {
	ApiService *RelationshipTuplesAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteRelationshipTupleRequest) Execute added in v1.0.5

func (ApiDeleteRelationshipTupleRequest) PermitSession added in v1.0.5

func (ApiDeleteRelationshipTupleRequest) RelationshipTupleDelete added in v1.0.5

type ApiDeleteResourceActionGroupRequest added in v0.0.10

type ApiDeleteResourceActionGroupRequest struct {
	ApiService *ResourceActionGroupsApiService
	// contains filtered or unexported fields
}

func (ApiDeleteResourceActionGroupRequest) Execute added in v0.0.10

type ApiDeleteResourceActionRequest

type ApiDeleteResourceActionRequest struct {
	ApiService *ResourceActionsApiService
	// contains filtered or unexported fields
}

func (ApiDeleteResourceActionRequest) Execute

type ApiDeleteResourceAttributeRequest

type ApiDeleteResourceAttributeRequest struct {
	ApiService *ResourceAttributesApiService
	// contains filtered or unexported fields
}

func (ApiDeleteResourceAttributeRequest) Execute

func (ApiDeleteResourceAttributeRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiDeleteResourceAttributeRequest) PerPage

The number of results per page (max 100).

type ApiDeleteResourceInstanceRequest

type ApiDeleteResourceInstanceRequest struct {
	ApiService *ResourceInstancesApiService
	// contains filtered or unexported fields
}

func (ApiDeleteResourceInstanceRequest) Execute

func (ApiDeleteResourceInstanceRequest) PermitSession added in v1.0.5

type ApiDeleteResourceRelationRequest added in v1.0.5

type ApiDeleteResourceRelationRequest struct {
	ApiService *ResourceRelationsAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteResourceRelationRequest) Execute added in v1.0.5

func (ApiDeleteResourceRelationRequest) PermitSession added in v1.0.5

type ApiDeleteResourceRequest

type ApiDeleteResourceRequest struct {
	ApiService *ResourcesApiService
	// contains filtered or unexported fields
}

func (ApiDeleteResourceRequest) Execute

func (r ApiDeleteResourceRequest) Execute() (*http.Response, error)

type ApiDeleteResourceRoleRequest

type ApiDeleteResourceRoleRequest struct {
	ApiService *ResourceRolesApiService
	// contains filtered or unexported fields
}

func (ApiDeleteResourceRoleRequest) Execute

func (ApiDeleteResourceRoleRequest) PermitSession added in v1.0.5

func (r ApiDeleteResourceRoleRequest) PermitSession(permitSession string) ApiDeleteResourceRoleRequest

type ApiDeleteRoleRequest

type ApiDeleteRoleRequest struct {
	ApiService *RolesApiService
	// contains filtered or unexported fields
}

func (ApiDeleteRoleRequest) Execute

func (r ApiDeleteRoleRequest) Execute() (*http.Response, error)

type ApiDeleteTenantRequest

type ApiDeleteTenantRequest struct {
	ApiService *TenantsApiService
	// contains filtered or unexported fields
}

func (ApiDeleteTenantRequest) Execute

func (r ApiDeleteTenantRequest) Execute() (*http.Response, error)

type ApiDeleteTenantUserRequest

type ApiDeleteTenantUserRequest struct {
	ApiService *TenantsApiService
	// contains filtered or unexported fields
}

func (ApiDeleteTenantUserRequest) Execute

type ApiDeleteUserAttributeRequest

type ApiDeleteUserAttributeRequest struct {
	ApiService *UserAttributesApiService
	// contains filtered or unexported fields
}

func (ApiDeleteUserAttributeRequest) Execute

func (ApiDeleteUserAttributeRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiDeleteUserAttributeRequest) PerPage

The number of results per page (max 100).

func (ApiDeleteUserAttributeRequest) ResourceId

type ApiDeleteUserRequest

type ApiDeleteUserRequest struct {
	ApiService *UsersApiService
	// contains filtered or unexported fields
}

func (ApiDeleteUserRequest) Execute

func (r ApiDeleteUserRequest) Execute() (*http.Response, error)

type ApiDevLoginRequest

type ApiDevLoginRequest struct {
	ApiService *AuthenticationApiService
	// contains filtered or unexported fields
}

func (ApiDevLoginRequest) DevLogin

func (ApiDevLoginRequest) Execute

func (r ApiDevLoginRequest) Execute() (*http.Response, error)

type ApiDisableActivePolicyRepoRequest

type ApiDisableActivePolicyRepoRequest struct {
	ApiService *PolicyGitRepositoriesApiService
	// contains filtered or unexported fields
}

func (ApiDisableActivePolicyRepoRequest) Execute

type ApiDummyDbRequest

type ApiDummyDbRequest struct {
	ApiService *DefaultApiService
	// contains filtered or unexported fields
}

func (ApiDummyDbRequest) Execute

func (r ApiDummyDbRequest) Execute() (interface{}, *http.Response, error)

type ApiDummyRequest

type ApiDummyRequest struct {
	ApiService *DefaultApiService
	// contains filtered or unexported fields
}

func (ApiDummyRequest) Execute

func (r ApiDummyRequest) Execute() (interface{}, *http.Response, error)

type ApiElementsAssignRoleToUserRequest

type ApiElementsAssignRoleToUserRequest struct {
	ApiService *ElementsDataApiService
	// contains filtered or unexported fields
}

func (ApiElementsAssignRoleToUserRequest) ElementsUserRoleCreate

func (ApiElementsAssignRoleToUserRequest) Execute

type ApiElementsCreateUserRequest

type ApiElementsCreateUserRequest struct {
	ApiService *ElementsDataApiService
	// contains filtered or unexported fields
}

func (ApiElementsCreateUserRequest) ElementsUserCreate

func (ApiElementsCreateUserRequest) Execute

type ApiElementsDeleteUserRequest

type ApiElementsDeleteUserRequest struct {
	ApiService *ElementsDataApiService
	// contains filtered or unexported fields
}

func (ApiElementsDeleteUserRequest) Execute

type ApiElementsListRolesRequest

type ApiElementsListRolesRequest struct {
	ApiService *ElementsDataApiService
	// contains filtered or unexported fields
}

func (ApiElementsListRolesRequest) Execute

func (ApiElementsListRolesRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiElementsListRolesRequest) PerPage

The number of results per page (max 100).

func (ApiElementsListRolesRequest) Search

Text search for the email field

type ApiElementsListUsersRequest

type ApiElementsListUsersRequest struct {
	ApiService *ElementsDataApiService
	// contains filtered or unexported fields
}

func (ApiElementsListUsersRequest) Execute

func (ApiElementsListUsersRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiElementsListUsersRequest) PerPage

The number of results per page (max 100).

func (ApiElementsListUsersRequest) Search

Text search for the email field

type ApiElementsLoginAsRequest

type ApiElementsLoginAsRequest struct {
	ApiService *AuthenticationApiService
	// contains filtered or unexported fields
}

func (ApiElementsLoginAsRequest) Execute

func (ApiElementsLoginAsRequest) UserLoginRequestInput

func (r ApiElementsLoginAsRequest) UserLoginRequestInput(userLoginRequestInput models.UserLoginRequestInput) ApiElementsLoginAsRequest

type ApiElementsUnassignRoleFromUserRequest

type ApiElementsUnassignRoleFromUserRequest struct {
	ApiService *ElementsDataApiService
	// contains filtered or unexported fields
}

func (ApiElementsUnassignRoleFromUserRequest) ElementsUserRoleRemove

func (ApiElementsUnassignRoleFromUserRequest) Execute

type ApiGetActiveOrganizationRequest

type ApiGetActiveOrganizationRequest struct {
	ApiService *OrganizationsApiService
	// contains filtered or unexported fields
}

func (ApiGetActiveOrganizationRequest) Execute

type ApiGetActivePolicyRepoRequest

type ApiGetActivePolicyRepoRequest struct {
	ApiService *PolicyGitRepositoriesApiService
	// contains filtered or unexported fields
}

func (ApiGetActivePolicyRepoRequest) Execute

type ApiGetAllDataRequest

type ApiGetAllDataRequest struct {
	ApiService *OPALDataApiService
	// contains filtered or unexported fields
}

func (ApiGetAllDataRequest) Execute

func (ApiGetAllDataRequest) InternalUpdateCache

func (r ApiGetAllDataRequest) InternalUpdateCache(internalUpdateCache bool) ApiGetAllDataRequest

type ApiGetApiKeyRequest

type ApiGetApiKeyRequest struct {
	ApiService *APIKeysApiService
	// contains filtered or unexported fields
}

func (ApiGetApiKeyRequest) Execute

type ApiGetApiKeyScopeRequest

type ApiGetApiKeyScopeRequest struct {
	ApiService *APIKeysApiService
	// contains filtered or unexported fields
}

func (ApiGetApiKeyScopeRequest) Execute

type ApiGetAuthenticatedMemberRequest

type ApiGetAuthenticatedMemberRequest struct {
	ApiService *MembersApiService
	// contains filtered or unexported fields
}

func (ApiGetAuthenticatedMemberRequest) Execute

type ApiGetAuthenticatingPdpConfigValuesLegacyRequest

type ApiGetAuthenticatingPdpConfigValuesLegacyRequest struct {
	ApiService *PolicyDecisionPointsApiService
	// contains filtered or unexported fields
}

func (ApiGetAuthenticatingPdpConfigValuesLegacyRequest) Execute

type ApiGetAuthenticatingPdpConfigValuesRequest

type ApiGetAuthenticatingPdpConfigValuesRequest struct {
	ApiService *PolicyDecisionPointsApiService
	// contains filtered or unexported fields
}

func (ApiGetAuthenticatingPdpConfigValuesRequest) Execute

func (ApiGetAuthenticatingPdpConfigValuesRequest) PDPStateUpdate

type ApiGetConditionSetAncestorsRequest added in v0.0.10

type ApiGetConditionSetAncestorsRequest struct {
	ApiService *ConditionSetsApiService
	// contains filtered or unexported fields
}

func (ApiGetConditionSetAncestorsRequest) Execute added in v0.0.10

func (ApiGetConditionSetAncestorsRequest) Page added in v0.0.10

Page number of the results to fetch, starting at 1.

func (ApiGetConditionSetAncestorsRequest) PerPage added in v0.0.10

The number of results per page (max 100).

type ApiGetConditionSetDescendantsRequest added in v0.0.10

type ApiGetConditionSetDescendantsRequest struct {
	ApiService *ConditionSetsApiService
	// contains filtered or unexported fields
}

func (ApiGetConditionSetDescendantsRequest) Execute added in v0.0.10

func (ApiGetConditionSetDescendantsRequest) Page added in v0.0.10

Page number of the results to fetch, starting at 1.

func (ApiGetConditionSetDescendantsRequest) PerPage added in v0.0.10

The number of results per page (max 100).

type ApiGetConditionSetPossibleParentsRequest added in v0.0.10

type ApiGetConditionSetPossibleParentsRequest struct {
	ApiService *ConditionSetsApiService
	// contains filtered or unexported fields
}

func (ApiGetConditionSetPossibleParentsRequest) Execute added in v0.0.10

func (ApiGetConditionSetPossibleParentsRequest) Page added in v0.0.10

Page number of the results to fetch, starting at 1.

func (ApiGetConditionSetPossibleParentsRequest) PerPage added in v0.0.10

The number of results per page (max 100).

type ApiGetConditionSetRequest

type ApiGetConditionSetRequest struct {
	ApiService *ConditionSetsApiService
	// contains filtered or unexported fields
}

func (ApiGetConditionSetRequest) Execute

type ApiGetDataForRoleRequest

type ApiGetDataForRoleRequest struct {
	ApiService *OPALDataApiService
	// contains filtered or unexported fields
}

func (ApiGetDataForRoleRequest) Execute

type ApiGetDataForSetRuleRequest

type ApiGetDataForSetRuleRequest struct {
	ApiService *OPALDataApiService
	// contains filtered or unexported fields
}

func (ApiGetDataForSetRuleRequest) Execute

func (r ApiGetDataForSetRuleRequest) Execute() (*map[string][]string, *http.Response, error)

type ApiGetDataForUserRequest

type ApiGetDataForUserRequest struct {
	ApiService *OPALDataApiService
	// contains filtered or unexported fields
}

func (ApiGetDataForUserRequest) Execute

type ApiGetElementsConfigRequest

type ApiGetElementsConfigRequest struct {
	ApiService *ElementsConfigsApiService
	// contains filtered or unexported fields
}

func (ApiGetElementsConfigRequest) Execute

type ApiGetEnvConfigRequest

type ApiGetEnvConfigRequest struct {
	ApiService *ElementsConfigsApiService
	// contains filtered or unexported fields
}

func (ApiGetEnvConfigRequest) Execute

type ApiGetEnvironmentApiKeyRequest

type ApiGetEnvironmentApiKeyRequest struct {
	ApiService *APIKeysApiService
	// contains filtered or unexported fields
}

func (ApiGetEnvironmentApiKeyRequest) Execute

type ApiGetEnvironmentRequest

type ApiGetEnvironmentRequest struct {
	ApiService *EnvironmentsApiService
	// contains filtered or unexported fields
}

func (ApiGetEnvironmentRequest) Execute

type ApiGetOpalDataSourcesOpalDataConfigGetRequest

type ApiGetOpalDataSourcesOpalDataConfigGetRequest struct {
	ApiService *PolicyApiService
	// contains filtered or unexported fields
}

func (ApiGetOpalDataSourcesOpalDataConfigGetRequest) Execute

func (ApiGetOpalDataSourcesOpalDataConfigGetRequest) Token

type ApiGetOpalDataSourcesRequest

type ApiGetOpalDataSourcesRequest struct {
	ApiService *PolicyApiService
	// contains filtered or unexported fields
}

func (ApiGetOpalDataSourcesRequest) Execute

func (ApiGetOpalDataSourcesRequest) Token

type ApiGetOrganizationMemberRequest

type ApiGetOrganizationMemberRequest struct {
	ApiService *MembersApiService
	// contains filtered or unexported fields
}

func (ApiGetOrganizationMemberRequest) Execute

type ApiGetOrganizationRequest

type ApiGetOrganizationRequest struct {
	ApiService *OrganizationsApiService
	// contains filtered or unexported fields
}

func (ApiGetOrganizationRequest) Execute

type ApiGetOrganizationV2StressDbOrganizationGetRequest

type ApiGetOrganizationV2StressDbOrganizationGetRequest struct {
	ApiService *DefaultApiService
	// contains filtered or unexported fields
}

func (ApiGetOrganizationV2StressDbOrganizationGetRequest) Execute

type ApiGetOrganizationWithAuthnRequest

type ApiGetOrganizationWithAuthnRequest struct {
	ApiService *DefaultApiService
	// contains filtered or unexported fields
}

func (ApiGetOrganizationWithAuthnRequest) Execute

type ApiGetOrganizationWithAuthzRequest

type ApiGetOrganizationWithAuthzRequest struct {
	ApiService *DefaultApiService
	// contains filtered or unexported fields
}

func (ApiGetOrganizationWithAuthzRequest) Execute

type ApiGetPdpConfigValuesRequest

type ApiGetPdpConfigValuesRequest struct {
	ApiService *PolicyDecisionPointsApiService
	// contains filtered or unexported fields
}

func (ApiGetPdpConfigValuesRequest) Execute

type ApiGetPolicyRepoRequest

type ApiGetPolicyRepoRequest struct {
	ApiService *PolicyGitRepositoriesApiService
	// contains filtered or unexported fields
}

func (ApiGetPolicyRepoRequest) Execute

type ApiGetProjectRequest

type ApiGetProjectRequest struct {
	ApiService *ProjectsApiService
	// contains filtered or unexported fields
}

func (ApiGetProjectRequest) Execute

type ApiGetProxyConfigRequest added in v1.0.1

type ApiGetProxyConfigRequest struct {
	ApiService *ProxyConfigAPIService
	// contains filtered or unexported fields
}

func (ApiGetProxyConfigRequest) Execute added in v1.0.1

type ApiGetResourceActionGroupRequest added in v0.0.10

type ApiGetResourceActionGroupRequest struct {
	ApiService *ResourceActionGroupsApiService
	// contains filtered or unexported fields
}

func (ApiGetResourceActionGroupRequest) Execute added in v0.0.10

type ApiGetResourceActionRequest

type ApiGetResourceActionRequest struct {
	ApiService *ResourceActionsApiService
	// contains filtered or unexported fields
}

func (ApiGetResourceActionRequest) Execute

type ApiGetResourceAttributeRequest

type ApiGetResourceAttributeRequest struct {
	ApiService *ResourceAttributesApiService
	// contains filtered or unexported fields
}

func (ApiGetResourceAttributeRequest) Execute

type ApiGetResourceInstanceRequest

type ApiGetResourceInstanceRequest struct {
	ApiService *ResourceInstancesApiService
	// contains filtered or unexported fields
}

func (ApiGetResourceInstanceRequest) Execute

func (ApiGetResourceInstanceRequest) PermitSession added in v1.0.5

type ApiGetResourceRelationRequest added in v1.0.5

type ApiGetResourceRelationRequest struct {
	ApiService *ResourceRelationsAPIService
	// contains filtered or unexported fields
}

func (ApiGetResourceRelationRequest) Execute added in v1.0.5

func (ApiGetResourceRelationRequest) PermitSession added in v1.0.5

type ApiGetResourceRequest

type ApiGetResourceRequest struct {
	ApiService *ResourcesApiService
	// contains filtered or unexported fields
}

func (ApiGetResourceRequest) Execute

type ApiGetResourceRoleAncestorsRequest added in v1.0.5

type ApiGetResourceRoleAncestorsRequest struct {
	ApiService *ResourceRolesApiService
	// contains filtered or unexported fields
}

func (ApiGetResourceRoleAncestorsRequest) Execute added in v1.0.5

func (ApiGetResourceRoleAncestorsRequest) PermitSession added in v1.0.5

type ApiGetResourceRoleDescendantsRequest added in v1.0.5

type ApiGetResourceRoleDescendantsRequest struct {
	ApiService *ResourceRolesApiService
	// contains filtered or unexported fields
}

func (ApiGetResourceRoleDescendantsRequest) Execute added in v1.0.5

func (ApiGetResourceRoleDescendantsRequest) PermitSession added in v1.0.5

type ApiGetResourceRoleRequest

type ApiGetResourceRoleRequest struct {
	ApiService *ResourceRolesApiService
	// contains filtered or unexported fields
}

func (ApiGetResourceRoleRequest) Execute

func (ApiGetResourceRoleRequest) PermitSession added in v1.0.5

func (r ApiGetResourceRoleRequest) PermitSession(permitSession string) ApiGetResourceRoleRequest

type ApiGetRoleRequest

type ApiGetRoleRequest struct {
	ApiService *RolesApiService
	// contains filtered or unexported fields
}

func (ApiGetRoleRequest) Execute

func (r ApiGetRoleRequest) Execute() (*models.RoleRead, *http.Response, error)

type ApiGetTenantRequest

type ApiGetTenantRequest struct {
	ApiService *TenantsApiService
	// contains filtered or unexported fields
}

func (ApiGetTenantRequest) Execute

type ApiGetUserAttributeRequest

type ApiGetUserAttributeRequest struct {
	ApiService *UserAttributesApiService
	// contains filtered or unexported fields
}

func (ApiGetUserAttributeRequest) Execute

func (ApiGetUserAttributeRequest) ResourceId

type ApiGetUserRequest

type ApiGetUserRequest struct {
	ApiService *UsersApiService
	// contains filtered or unexported fields
}

func (ApiGetUserRequest) Execute

func (r ApiGetUserRequest) Execute() (*models.UserRead, *http.Response, error)

type ApiInsertOpaDecisionLogsRequest

type ApiInsertOpaDecisionLogsRequest struct {
	ApiService *DecisionLogsIngressApiService
	// contains filtered or unexported fields
}

func (ApiInsertOpaDecisionLogsRequest) Execute

func (ApiInsertOpaDecisionLogsRequest) RequestBody

func (r ApiInsertOpaDecisionLogsRequest) RequestBody(requestBody []map[string]interface{}) ApiInsertOpaDecisionLogsRequest

type ApiInviteMembersToOrganizationRequest

type ApiInviteMembersToOrganizationRequest struct {
	ApiService *OrganizationsApiService
	// contains filtered or unexported fields
}

func (ApiInviteMembersToOrganizationRequest) Execute

func (ApiInviteMembersToOrganizationRequest) InviteCreate

func (ApiInviteMembersToOrganizationRequest) InviterEmail

func (ApiInviteMembersToOrganizationRequest) InviterName

type ApiListApiKeysRequest

type ApiListApiKeysRequest struct {
	ApiService *APIKeysApiService
	// contains filtered or unexported fields
}

func (ApiListApiKeysRequest) Execute

func (ApiListApiKeysRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListApiKeysRequest) PerPage

The number of results per page (max 100).

type ApiListConditionSetsRequest

type ApiListConditionSetsRequest struct {
	ApiService *ConditionSetsApiService
	// contains filtered or unexported fields
}

func (ApiListConditionSetsRequest) IncludeTotalCount added in v0.0.10

func (r ApiListConditionSetsRequest) IncludeTotalCount(includeTotalCount bool) ApiListConditionSetsRequest

Include total count in response

func (ApiListConditionSetsRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListConditionSetsRequest) PerPage

The number of results per page (max 100).

func (ApiListConditionSetsRequest) Type_

if provided, will return only the condition sets of the specified type. e.g: only user sets.

type ApiListElementsConfigsRequest

type ApiListElementsConfigsRequest struct {
	ApiService *ElementsConfigsApiService
	// contains filtered or unexported fields
}

func (ApiListElementsConfigsRequest) Execute

func (ApiListElementsConfigsRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListElementsConfigsRequest) PerPage

The number of results per page (max 100).

type ApiListEnvironmentsRequest

type ApiListEnvironmentsRequest struct {
	ApiService *EnvironmentsApiService
	// contains filtered or unexported fields
}

func (ApiListEnvironmentsRequest) Execute

func (ApiListEnvironmentsRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListEnvironmentsRequest) PerPage

The number of results per page (max 100).

type ApiListLanguageInstructionsRequest

type ApiListLanguageInstructionsRequest struct {
	ApiService *InstructionsApiService
	// contains filtered or unexported fields
}

func (ApiListLanguageInstructionsRequest) Execute

type ApiListOrganizationInvitesRequest

type ApiListOrganizationInvitesRequest struct {
	ApiService *OrganizationsApiService
	// contains filtered or unexported fields
}

func (ApiListOrganizationInvitesRequest) Execute

func (ApiListOrganizationInvitesRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListOrganizationInvitesRequest) PerPage

The number of results per page (max 100).

type ApiListOrganizationMembersRequest

type ApiListOrganizationMembersRequest struct {
	ApiService *MembersApiService
	// contains filtered or unexported fields
}

func (ApiListOrganizationMembersRequest) Execute

func (ApiListOrganizationMembersRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListOrganizationMembersRequest) PerPage

The number of results per page (max 100).

type ApiListOrganizationsRequest

type ApiListOrganizationsRequest struct {
	ApiService *OrganizationsApiService
	// contains filtered or unexported fields
}

func (ApiListOrganizationsRequest) Execute

func (ApiListOrganizationsRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListOrganizationsRequest) PerPage

The number of results per page (max 100).

type ApiListPdpConfigsRequest

type ApiListPdpConfigsRequest struct {
	ApiService *PolicyDecisionPointsApiService
	// contains filtered or unexported fields
}

func (ApiListPdpConfigsRequest) Execute

func (ApiListPdpConfigsRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListPdpConfigsRequest) PerPage

The number of results per page (max 100).

type ApiListPdpDecisionLogsRequest

type ApiListPdpDecisionLogsRequest struct {
	ApiService *DecisionLogsApiService
	// contains filtered or unexported fields
}

func (ApiListPdpDecisionLogsRequest) Approved

Filter by approved decisions

func (ApiListPdpDecisionLogsRequest) Execute

func (ApiListPdpDecisionLogsRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListPdpDecisionLogsRequest) PerPage

The number of results per page (max 100).

func (ApiListPdpDecisionLogsRequest) Resources

Filter by resources

func (ApiListPdpDecisionLogsRequest) TimestampFrom

func (r ApiListPdpDecisionLogsRequest) TimestampFrom(timestampFrom int32) ApiListPdpDecisionLogsRequest

Filter by timestamp from

func (ApiListPdpDecisionLogsRequest) TimestampTo

Filter by timestamp to

func (ApiListPdpDecisionLogsRequest) Users

List of user IDs to filter by

type ApiListPolicyReposRequest

type ApiListPolicyReposRequest struct {
	ApiService *PolicyGitRepositoriesApiService
	// contains filtered or unexported fields
}

func (ApiListPolicyReposRequest) Execute

func (ApiListPolicyReposRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListPolicyReposRequest) PerPage

The number of results per page (max 100).

type ApiListProjectsRequest

type ApiListProjectsRequest struct {
	ApiService *ProjectsApiService
	// contains filtered or unexported fields
}

func (ApiListProjectsRequest) Execute

func (ApiListProjectsRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListProjectsRequest) PerPage

The number of results per page (max 100).

type ApiListProxyConfigsRequest added in v1.0.1

type ApiListProxyConfigsRequest struct {
	ApiService *ProxyConfigAPIService
	// contains filtered or unexported fields
}

func (ApiListProxyConfigsRequest) Execute added in v1.0.1

func (ApiListProxyConfigsRequest) Page added in v1.0.1

Page number of the results to fetch, starting at 1.

func (ApiListProxyConfigsRequest) PerPage added in v1.0.1

The number of results per page (max 100).

type ApiListRelationshipTuplesRequest added in v1.0.5

type ApiListRelationshipTuplesRequest struct {
	ApiService *RelationshipTuplesAPIService
	// contains filtered or unexported fields
}

func (ApiListRelationshipTuplesRequest) Detailed added in v1.0.5

If true, will return the full subject and object resource instances.

func (ApiListRelationshipTuplesRequest) Execute added in v1.0.5

func (ApiListRelationshipTuplesRequest) Object added in v1.0.5

The object to filter by, accepts either the resource instance id or resource_type:resource_instance

func (ApiListRelationshipTuplesRequest) Page added in v1.0.5

Page number of the results to fetch, starting at 1.

func (ApiListRelationshipTuplesRequest) PerPage added in v1.0.5

The number of results per page (max 100).

func (ApiListRelationshipTuplesRequest) PermitSession added in v1.0.5

func (ApiListRelationshipTuplesRequest) Relation added in v1.0.5

The relation id or key to filter by

func (ApiListRelationshipTuplesRequest) Subject added in v1.0.5

The subject to filter by, accepts either the resource instance id or resource_type:resource_instance

func (ApiListRelationshipTuplesRequest) Tenant added in v1.0.5

The tenant key or id to filter by

type ApiListResourceActionGroupsRequest added in v0.0.10

type ApiListResourceActionGroupsRequest struct {
	ApiService *ResourceActionGroupsApiService
	// contains filtered or unexported fields
}

func (ApiListResourceActionGroupsRequest) AttributesFilter added in v0.0.10

func (r ApiListResourceActionGroupsRequest) AttributesFilter(attributesFilter map[string]interface{}) ApiListResourceActionGroupsRequest

AttributeFilters on the result of the actions list

func (ApiListResourceActionGroupsRequest) Execute added in v0.0.10

func (ApiListResourceActionGroupsRequest) Page added in v0.0.10

Page number of the results to fetch, starting at 1.

func (ApiListResourceActionGroupsRequest) PerPage added in v0.0.10

The number of results per page (max 100).

type ApiListResourceActionsRequest

type ApiListResourceActionsRequest struct {
	ApiService *ResourceActionsApiService
	// contains filtered or unexported fields
}

func (ApiListResourceActionsRequest) AttributesFilter added in v0.0.10

func (r ApiListResourceActionsRequest) AttributesFilter(attributesFilter map[string]interface{}) ApiListResourceActionsRequest

AttributeFilters on the result of the actions list

func (ApiListResourceActionsRequest) Execute

func (ApiListResourceActionsRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListResourceActionsRequest) PerPage

The number of results per page (max 100).

type ApiListResourceAttributesRequest

type ApiListResourceAttributesRequest struct {
	ApiService *ResourceAttributesApiService
	// contains filtered or unexported fields
}

func (ApiListResourceAttributesRequest) Execute

func (ApiListResourceAttributesRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListResourceAttributesRequest) PerPage

The number of results per page (max 100).

type ApiListResourceInstancesRequest

type ApiListResourceInstancesRequest struct {
	ApiService *ResourceInstancesApiService
	// contains filtered or unexported fields
}

func (ApiListResourceInstancesRequest) Detailed added in v1.0.5

If true, will return the relationships of the resource instance.

func (ApiListResourceInstancesRequest) Execute

func (ApiListResourceInstancesRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListResourceInstancesRequest) PerPage

The number of results per page (max 100).

func (ApiListResourceInstancesRequest) PermitSession added in v1.0.5

func (ApiListResourceInstancesRequest) Resource added in v1.0.5

The resource key or id to filter by

func (ApiListResourceInstancesRequest) Search added in v1.0.5

Text search for the object name or key

func (ApiListResourceInstancesRequest) Tenant added in v1.0.5

The tenant key or id to filter by

type ApiListResourceRelationsRequest added in v1.0.5

type ApiListResourceRelationsRequest struct {
	ApiService *ResourceRelationsAPIService
	// contains filtered or unexported fields
}

func (ApiListResourceRelationsRequest) Execute added in v1.0.5

func (ApiListResourceRelationsRequest) Page added in v1.0.5

Page number of the results to fetch, starting at 1.

func (ApiListResourceRelationsRequest) PerPage added in v1.0.5

The number of results per page (max 100).

func (ApiListResourceRelationsRequest) PermitSession added in v1.0.5

type ApiListResourceRolesRequest

type ApiListResourceRolesRequest struct {
	ApiService *ResourceRolesApiService
	// contains filtered or unexported fields
}

func (ApiListResourceRolesRequest) Execute

func (ApiListResourceRolesRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListResourceRolesRequest) PerPage

The number of results per page (max 100).

func (ApiListResourceRolesRequest) PermitSession added in v1.0.5

func (r ApiListResourceRolesRequest) PermitSession(permitSession string) ApiListResourceRolesRequest

type ApiListResourcesRequest

type ApiListResourcesRequest struct {
	ApiService *ResourcesApiService
	// contains filtered or unexported fields
}

func (ApiListResourcesRequest) Execute

func (ApiListResourcesRequest) IncludeBuiltIn

func (r ApiListResourcesRequest) IncludeBuiltIn(includeBuiltIn bool) ApiListResourcesRequest

Whether to include or exclude built-in resources, default is False

func (ApiListResourcesRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListResourcesRequest) PerPage

The number of results per page (max 100).

func (ApiListResourcesRequest) Search added in v0.0.13

Text search for the object name or key

type ApiListRoleAssignmentsRequest

type ApiListRoleAssignmentsRequest struct {
	ApiService *RoleAssignmentsApiService
	// contains filtered or unexported fields
}

func (ApiListRoleAssignmentsRequest) Detailed added in v0.0.13

Whether to return full details about the user, tenant and role

func (ApiListRoleAssignmentsRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListRoleAssignmentsRequest) PerPage

The number of results per page (max 100).

func (ApiListRoleAssignmentsRequest) PermitSession added in v1.0.5

func (ApiListRoleAssignmentsRequest) Resource added in v1.0.5

optional resource **type** filter, will only return role assignments granted on that resource type.

func (ApiListRoleAssignmentsRequest) ResourceInstance added in v1.0.5

func (r ApiListRoleAssignmentsRequest) ResourceInstance(resourceInstance string) ApiListRoleAssignmentsRequest

optional resource instance filter, will only return role assignments granted on that resource instance.

func (ApiListRoleAssignmentsRequest) Role

optional role filter, will only return role assignments granting this role.

func (ApiListRoleAssignmentsRequest) Tenant

optional tenant filter, will only return role assignments granted in that tenant.

func (ApiListRoleAssignmentsRequest) User

optional user filter, will only return role assignments granted to this user.

type ApiListRolesRequest

type ApiListRolesRequest struct {
	ApiService *RolesApiService
	// contains filtered or unexported fields
}

func (ApiListRolesRequest) AttributesFilter added in v0.0.9

func (r ApiListRolesRequest) AttributesFilter(attributesFilter map[string]interface{}) ApiListRolesRequest

AttributeFilters on the result of the tenant list

func (ApiListRolesRequest) Execute

func (ApiListRolesRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListRolesRequest) PerPage

func (r ApiListRolesRequest) PerPage(perPage int32) ApiListRolesRequest

The number of results per page (max 100).

type ApiListSetPermissionsRequest

type ApiListSetPermissionsRequest struct {
	ApiService *ConditionSetRulesApiService
	// contains filtered or unexported fields
}

func (ApiListSetPermissionsRequest) Execute

func (ApiListSetPermissionsRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListSetPermissionsRequest) PerPage

The number of results per page (max 100).

func (ApiListSetPermissionsRequest) Permission

optional permission filter, will only return condition set rules granting this permission

func (ApiListSetPermissionsRequest) ResourceSet

optional resource set filter, will only return rules where the permission is granted on this resource set

func (ApiListSetPermissionsRequest) UserSet

optional user set filter, will only return rules where the permission is granted to this user set

type ApiListTenantUsersRequest

type ApiListTenantUsersRequest struct {
	ApiService *TenantsApiService
	// contains filtered or unexported fields
}

func (ApiListTenantUsersRequest) Execute

func (ApiListTenantUsersRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListTenantUsersRequest) PerPage

The number of results per page (max 100).

func (ApiListTenantUsersRequest) Search

Text search for the email field

type ApiListTenantsRequest

type ApiListTenantsRequest struct {
	ApiService *TenantsApiService
	// contains filtered or unexported fields
}

func (ApiListTenantsRequest) AttributeFilter added in v0.0.9

func (r ApiListTenantsRequest) AttributeFilter(attributesFilter map[string]interface{}) ApiListTenantsRequest

Filter for tenant with specific attributes

func (ApiListTenantsRequest) Execute

func (ApiListTenantsRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListTenantsRequest) PerPage

The number of results per page (max 100).

func (ApiListTenantsRequest) Search

Text search for the tenant name or key

type ApiListUserAttributesRequest

type ApiListUserAttributesRequest struct {
	ApiService *UserAttributesApiService
	// contains filtered or unexported fields
}

func (ApiListUserAttributesRequest) Execute

func (ApiListUserAttributesRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListUserAttributesRequest) PerPage

The number of results per page (max 100).

func (ApiListUserAttributesRequest) ResourceId

type ApiListUsersRequest

type ApiListUsersRequest struct {
	ApiService *UsersApiService
	// contains filtered or unexported fields
}

func (ApiListUsersRequest) Execute

func (ApiListUsersRequest) Page

Page number of the results to fetch, starting at 1.

func (ApiListUsersRequest) PerPage

func (r ApiListUsersRequest) PerPage(perPage int32) ApiListUsersRequest

The number of results per page (max 100).

func (ApiListUsersRequest) Search

Text search for the email field

type ApiLoginElementsRequest

type ApiLoginElementsRequest struct {
	ApiService *AuthenticationApiService
	// contains filtered or unexported fields
}

func (ApiLoginElementsRequest) Execute

func (ApiLoginElementsRequest) Token

type ApiLoginRequest

type ApiLoginRequest struct {
	ApiService *AuthenticationApiService
	// contains filtered or unexported fields
}

func (ApiLoginRequest) Execute

func (ApiLoginRequest) InviteCode

func (r ApiLoginRequest) InviteCode(inviteCode string) ApiLoginRequest

An optional invite code to an existing organization. If the invite code is provided and is valid, the member will gain access to that organization.

type ApiLogoutGetRequest

type ApiLogoutGetRequest struct {
	ApiService *AuthenticationApiService
	// contains filtered or unexported fields
}

func (ApiLogoutGetRequest) Execute

func (r ApiLogoutGetRequest) Execute() (*http.Response, error)

type ApiLogoutPostRequest

type ApiLogoutPostRequest struct {
	ApiService *AuthenticationApiService
	// contains filtered or unexported fields
}

func (ApiLogoutPostRequest) Execute

func (r ApiLogoutPostRequest) Execute() (*http.Response, error)

type ApiMeRequest

type ApiMeRequest struct {
	ApiService *AuthenticationApiService
	// contains filtered or unexported fields
}

func (ApiMeRequest) Execute

func (r ApiMeRequest) Execute() (*models.AuthnMeRead, *http.Response, error)

type ApiRemoveParentResourceRoleRequest

type ApiRemoveParentResourceRoleRequest struct {
	ApiService *ResourceRolesApiService
	// contains filtered or unexported fields
}

func (ApiRemoveParentResourceRoleRequest) Execute

func (ApiRemoveParentResourceRoleRequest) PermitSession added in v1.0.5

type ApiRemoveParentRoleRequest

type ApiRemoveParentRoleRequest struct {
	ApiService *RolesApiService
	// contains filtered or unexported fields
}

func (ApiRemoveParentRoleRequest) Execute

type ApiRemovePermissionsFromResourceRoleRequest

type ApiRemovePermissionsFromResourceRoleRequest struct {
	ApiService *ResourceRolesApiService
	// contains filtered or unexported fields
}

func (ApiRemovePermissionsFromResourceRoleRequest) Execute

func (ApiRemovePermissionsFromResourceRoleRequest) PermitSession added in v1.0.5

func (ApiRemovePermissionsFromResourceRoleRequest) RemoveRolePermissions

type ApiRemovePermissionsFromRoleRequest

type ApiRemovePermissionsFromRoleRequest struct {
	ApiService *RolesApiService
	// contains filtered or unexported fields
}

func (ApiRemovePermissionsFromRoleRequest) Execute

func (ApiRemovePermissionsFromRoleRequest) RemoveRolePermissions

type ApiReplaceResourceRequest

type ApiReplaceResourceRequest struct {
	ApiService *ResourcesApiService
	// contains filtered or unexported fields
}

func (ApiReplaceResourceRequest) Execute

func (ApiReplaceResourceRequest) ResourceReplace

type ApiReplaceUserRequest

type ApiReplaceUserRequest struct {
	ApiService *UsersApiService
	// contains filtered or unexported fields
}

func (ApiReplaceUserRequest) Execute

func (ApiReplaceUserRequest) UserCreate

type ApiRotatePdpApiKeyRequest

type ApiRotatePdpApiKeyRequest struct {
	ApiService *PolicyDecisionPointsApiService
	// contains filtered or unexported fields
}

func (ApiRotatePdpApiKeyRequest) Execute

type ApiSetConfigActiveRequest

type ApiSetConfigActiveRequest struct {
	ApiService *ElementsDataApiService
	// contains filtered or unexported fields
}

func (ApiSetConfigActiveRequest) Execute

func (r ApiSetConfigActiveRequest) Execute() (*http.Response, error)

type ApiStatsEnvironmentsRequest

type ApiStatsEnvironmentsRequest struct {
	ApiService *EnvironmentsApiService
	// contains filtered or unexported fields
}

func (ApiStatsEnvironmentsRequest) Execute

type ApiSwitchOrganizationRequest

type ApiSwitchOrganizationRequest struct {
	ApiService *AuthenticationApiService
	// contains filtered or unexported fields
}

func (ApiSwitchOrganizationRequest) Execute

type ApiUnassignRoleFromUserRequest

type ApiUnassignRoleFromUserRequest struct {
	ApiService *UsersApiService
	// contains filtered or unexported fields
}

func (ApiUnassignRoleFromUserRequest) Execute

func (ApiUnassignRoleFromUserRequest) UserRoleRemove

type ApiUnassignRoleRequest

type ApiUnassignRoleRequest struct {
	ApiService *RoleAssignmentsApiService
	// contains filtered or unexported fields
}

func (ApiUnassignRoleRequest) Execute

func (r ApiUnassignRoleRequest) Execute() (*http.Response, error)

func (ApiUnassignRoleRequest) PermitSession added in v1.0.5

func (r ApiUnassignRoleRequest) PermitSession(permitSession string) ApiUnassignRoleRequest

func (ApiUnassignRoleRequest) RoleAssignmentRemove

func (r ApiUnassignRoleRequest) RoleAssignmentRemove(roleAssignmentRemove models.RoleAssignmentRemove) ApiUnassignRoleRequest

type ApiUnassignSetPermissionsRequest

type ApiUnassignSetPermissionsRequest struct {
	ApiService *ConditionSetRulesApiService
	// contains filtered or unexported fields
}

func (ApiUnassignSetPermissionsRequest) ConditionSetRuleRemove

func (ApiUnassignSetPermissionsRequest) Execute

type ApiUpdateConditionSetRequest

type ApiUpdateConditionSetRequest struct {
	ApiService *ConditionSetsApiService
	// contains filtered or unexported fields
}

func (ApiUpdateConditionSetRequest) ConditionSetUpdate

func (ApiUpdateConditionSetRequest) Execute

type ApiUpdateElementsConfigRequest

type ApiUpdateElementsConfigRequest struct {
	ApiService *ElementsConfigsApiService
	// contains filtered or unexported fields
}

func (ApiUpdateElementsConfigRequest) ElementsConfigUpdate

func (ApiUpdateElementsConfigRequest) Execute

type ApiUpdateElementsEnvRequest

type ApiUpdateElementsEnvRequest struct {
	ApiService *ElementsConfigsApiService
	// contains filtered or unexported fields
}

func (ApiUpdateElementsEnvRequest) ElementsEnvUpdate

func (ApiUpdateElementsEnvRequest) Execute

type ApiUpdateEnvironmentRequest

type ApiUpdateEnvironmentRequest struct {
	ApiService *EnvironmentsApiService
	// contains filtered or unexported fields
}

func (ApiUpdateEnvironmentRequest) EnvironmentUpdate

func (ApiUpdateEnvironmentRequest) Execute

type ApiUpdateImplicitGrantsConditionsRequest added in v1.0.5

type ApiUpdateImplicitGrantsConditionsRequest struct {
	ApiService *ImplicitGrantsAPIService
	// contains filtered or unexported fields
}

func (ApiUpdateImplicitGrantsConditionsRequest) Execute added in v1.0.5

func (ApiUpdateImplicitGrantsConditionsRequest) PermitBackendSchemasSchemaDerivedRoleRuleDerivationSettings added in v1.0.5

func (r ApiUpdateImplicitGrantsConditionsRequest) PermitBackendSchemasSchemaDerivedRoleRuleDerivationSettings(permitBackendSchemasSchemaDerivedRoleRuleDerivationSettings models.PermitBackendSchemasSchemaDerivedRoleRuleDerivationSettings) ApiUpdateImplicitGrantsConditionsRequest

func (ApiUpdateImplicitGrantsConditionsRequest) PermitSession added in v1.0.5

type ApiUpdateOrganizationMemberRequest

type ApiUpdateOrganizationMemberRequest struct {
	ApiService *MembersApiService
	// contains filtered or unexported fields
}

func (ApiUpdateOrganizationMemberRequest) Execute

func (ApiUpdateOrganizationMemberRequest) OrgMemberUpdate

type ApiUpdateOrganizationRequest

type ApiUpdateOrganizationRequest struct {
	ApiService *OrganizationsApiService
	// contains filtered or unexported fields
}

func (ApiUpdateOrganizationRequest) Execute

func (ApiUpdateOrganizationRequest) OrganizationUpdate

type ApiUpdateProjectRequest

type ApiUpdateProjectRequest struct {
	ApiService *ProjectsApiService
	// contains filtered or unexported fields
}

func (ApiUpdateProjectRequest) Execute

func (ApiUpdateProjectRequest) ProjectUpdate

type ApiUpdateProxyConfigRequest added in v1.0.1

type ApiUpdateProxyConfigRequest struct {
	ApiService *ProxyConfigAPIService
	// contains filtered or unexported fields
}

func (ApiUpdateProxyConfigRequest) Execute added in v1.0.1

func (ApiUpdateProxyConfigRequest) ProxyConfigUpdate added in v1.0.1

type ApiUpdateResourceActionRequest

type ApiUpdateResourceActionRequest struct {
	ApiService *ResourceActionsApiService
	// contains filtered or unexported fields
}

func (ApiUpdateResourceActionRequest) Execute

func (ApiUpdateResourceActionRequest) ResourceActionUpdate

type ApiUpdateResourceAttributeRequest

type ApiUpdateResourceAttributeRequest struct {
	ApiService *ResourceAttributesApiService
	// contains filtered or unexported fields
}

func (ApiUpdateResourceAttributeRequest) Execute

func (ApiUpdateResourceAttributeRequest) ResourceAttributeUpdate

type ApiUpdateResourceInstanceRequest

type ApiUpdateResourceInstanceRequest struct {
	ApiService *ResourceInstancesApiService
	// contains filtered or unexported fields
}

func (ApiUpdateResourceInstanceRequest) Execute

func (ApiUpdateResourceInstanceRequest) PermitSession added in v1.0.5

func (ApiUpdateResourceInstanceRequest) ResourceInstanceUpdate

type ApiUpdateResourceRequest

type ApiUpdateResourceRequest struct {
	ApiService *ResourcesApiService
	// contains filtered or unexported fields
}

func (ApiUpdateResourceRequest) Execute

func (ApiUpdateResourceRequest) ResourceUpdate

type ApiUpdateResourceRoleRequest

type ApiUpdateResourceRoleRequest struct {
	ApiService *ResourceRolesApiService
	// contains filtered or unexported fields
}

func (ApiUpdateResourceRoleRequest) Execute

func (ApiUpdateResourceRoleRequest) PermitSession added in v1.0.5

func (r ApiUpdateResourceRoleRequest) PermitSession(permitSession string) ApiUpdateResourceRoleRequest

func (ApiUpdateResourceRoleRequest) ResourceRoleUpdate

type ApiUpdateRoleRequest

type ApiUpdateRoleRequest struct {
	ApiService *RolesApiService
	// contains filtered or unexported fields
}

func (ApiUpdateRoleRequest) Execute

func (ApiUpdateRoleRequest) RoleUpdate

type ApiUpdateTenantRequest

type ApiUpdateTenantRequest struct {
	ApiService *TenantsApiService
	// contains filtered or unexported fields
}

func (ApiUpdateTenantRequest) Execute

func (ApiUpdateTenantRequest) TenantUpdate

type ApiUpdateUserAttributeRequest

type ApiUpdateUserAttributeRequest struct {
	ApiService *UserAttributesApiService
	// contains filtered or unexported fields
}

func (ApiUpdateUserAttributeRequest) Execute

func (ApiUpdateUserAttributeRequest) ResourceAttributeUpdate

func (r ApiUpdateUserAttributeRequest) ResourceAttributeUpdate(resourceAttributeUpdate models.ResourceAttributeUpdate) ApiUpdateUserAttributeRequest

func (ApiUpdateUserAttributeRequest) ResourceId

type ApiUpdateUserRequest

type ApiUpdateUserRequest struct {
	ApiService *UsersApiService
	// contains filtered or unexported fields
}

func (ApiUpdateUserRequest) Execute

func (ApiUpdateUserRequest) UserUpdate

type AuthenticationApiService

type AuthenticationApiService service

AuthenticationApiService AuthenticationApi service

func (*AuthenticationApiService) DevLogin

DevLogin (DEV MODE) Login

The dev-login endpoints allows a developer inside permit.io to log in with an email address.

THIS IS ONLY AVAILABLE IN DEV MODE.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiDevLoginRequest

func (*AuthenticationApiService) DevLoginExecute

Execute executes the request

func (*AuthenticationApiService) ElementsLoginAs

ElementsLoginAs Elements Login As

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiElementsLoginAsRequest

func (*AuthenticationApiService) ElementsLoginAsExecute

Execute executes the request

@return EmbeddedLoginRequestOutput

func (*AuthenticationApiService) Login

Login Login

The login endpoint allows the frontend app to exchange a user JWT with a user session. The user session is stored on an httpOnly + secure cookie.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiLoginRequest

func (*AuthenticationApiService) LoginElements

LoginElements Login Elements

The login endpoint allows the frontend app to exchange a user JWT with a user session. The user session is stored on an httpOnly + secure cookie.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiLoginElementsRequest

func (*AuthenticationApiService) LoginElementsExecute

Execute executes the request

@return LoginResult

func (*AuthenticationApiService) LoginExecute

Execute executes the request

@return LoginResult

func (*AuthenticationApiService) LogoutGet

LogoutGet Logout Get

The logout endpoint deletes the session cookie of a logged in user and invalidates cached VCs.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiLogoutGetRequest

func (*AuthenticationApiService) LogoutGetExecute

func (a *AuthenticationApiService) LogoutGetExecute(r ApiLogoutGetRequest) (*http.Response, error)

Execute executes the request

func (*AuthenticationApiService) LogoutPost

LogoutPost Logout Post

The logout endpoint deletes the session cookie of a logged in user and invalidates cached VCs.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiLogoutPostRequest

func (*AuthenticationApiService) LogoutPostExecute

func (a *AuthenticationApiService) LogoutPostExecute(r ApiLogoutPostRequest) (*http.Response, error)

Execute executes the request

func (*AuthenticationApiService) Me

Me Me

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiMeRequest

func (*AuthenticationApiService) MeExecute

Execute executes the request

@return AuthnMeRead

func (*AuthenticationApiService) SwitchOrganization

SwitchOrganization Switch Organization

Allows the user to switch his active organization (manipulates the user's login session).

This route will return a new login cookie to the user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId the organization id the user wishes to switch to as the active org on the session
@return ApiSwitchOrganizationRequest

func (*AuthenticationApiService) SwitchOrganizationExecute

Execute executes the request

@return LoginResult

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type ConditionSetRulesApiService

type ConditionSetRulesApiService service

ConditionSetRulesApiService ConditionSetRulesApi service

func (*ConditionSetRulesApiService) AssignSetPermissions

func (a *ConditionSetRulesApiService) AssignSetPermissions(ctx context.Context, projId string, envId string) ApiAssignSetPermissionsRequest

AssignSetPermissions Assign Set Permissions

Grant permissions to a user set *on* a resource set.

If the permission is already granted, it is skipped.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiAssignSetPermissionsRequest

func (*ConditionSetRulesApiService) AssignSetPermissionsExecute

Execute executes the request

@return []ConditionSetRuleRead

func (*ConditionSetRulesApiService) ListSetPermissions

func (a *ConditionSetRulesApiService) ListSetPermissions(ctx context.Context, projId string, envId string) ApiListSetPermissionsRequest

ListSetPermissions List Set Permissions

Lists the condition set rules matching the filter. - If the `user_set` filter is present, will only return the permissions set of that user set. - If the `permission` filter is present, will only return the permissions sets that equals to the queried permission. - If the `resource_set` filter is present, will only return the permissions set of that resource set.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListSetPermissionsRequest

func (*ConditionSetRulesApiService) ListSetPermissionsExecute

Execute executes the request

@return []ConditionSetRuleRead

func (*ConditionSetRulesApiService) UnassignSetPermissions

func (a *ConditionSetRulesApiService) UnassignSetPermissions(ctx context.Context, projId string, envId string) ApiUnassignSetPermissionsRequest

UnassignSetPermissions Unassign Set Permissions

Revokes permissions to a user set *on* a resource set.

If the permission is not granted, it is skipped.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiUnassignSetPermissionsRequest

func (*ConditionSetRulesApiService) UnassignSetPermissionsExecute

func (a *ConditionSetRulesApiService) UnassignSetPermissionsExecute(r ApiUnassignSetPermissionsRequest) (*http.Response, error)

Execute executes the request

type ConditionSetsApiService

type ConditionSetsApiService service

ConditionSetsApiService ConditionSetsApi service

func (*ConditionSetsApiService) CreateConditionSet

func (a *ConditionSetsApiService) CreateConditionSet(ctx context.Context, projId string, envId string) ApiCreateConditionSetRequest

CreateConditionSet Create Condition Set

Creates a new condition set (can be either a user set or a resource set).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiCreateConditionSetRequest

func (*ConditionSetsApiService) CreateConditionSetExecute

Execute executes the request

@return ConditionSetRead

func (*ConditionSetsApiService) DeleteConditionSet

func (a *ConditionSetsApiService) DeleteConditionSet(ctx context.Context, projId string, envId string, conditionSetId string) ApiDeleteConditionSetRequest

DeleteConditionSet Delete Condition Set

Deletes a condition set and all its related data. This includes any permissions granted to said condition set (i.e: any matching condition set rules).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param conditionSetId Either the unique id of the condition set, or the URL-friendly key of the condition set (i.e: the \"slug\").
@return ApiDeleteConditionSetRequest

func (*ConditionSetsApiService) DeleteConditionSetExecute

func (a *ConditionSetsApiService) DeleteConditionSetExecute(r ApiDeleteConditionSetRequest) (*http.Response, error)

Execute executes the request

func (*ConditionSetsApiService) GetConditionSet

func (a *ConditionSetsApiService) GetConditionSet(ctx context.Context, projId string, envId string, conditionSetId string) ApiGetConditionSetRequest

GetConditionSet Get Condition Set

Gets a single condition set, if such condition set exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param conditionSetId Either the unique id of the condition set, or the URL-friendly key of the condition set (i.e: the \"slug\").
@return ApiGetConditionSetRequest

func (*ConditionSetsApiService) GetConditionSetAncestors added in v0.0.10

func (a *ConditionSetsApiService) GetConditionSetAncestors(ctx context.Context, projId string, envId string, conditionSetId string) ApiGetConditionSetAncestorsRequest

GetConditionSetAncestors Get Condition Set Ancestors

Gets all ancestors (parent, parent of parent, and so on)

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param conditionSetId Either the unique id of the condition set, or the URL-friendly key of the condition set (i.e: the \"slug\").
@return ApiGetConditionSetAncestorsRequest

func (*ConditionSetsApiService) GetConditionSetAncestorsExecute added in v0.0.10

Execute executes the request

@return []ConditionSetRead

func (*ConditionSetsApiService) GetConditionSetDescendants added in v0.0.10

func (a *ConditionSetsApiService) GetConditionSetDescendants(ctx context.Context, projId string, envId string, conditionSetId string) ApiGetConditionSetDescendantsRequest

GetConditionSetDescendants Get Condition Set Descendants

Gets all descendants (children, children of children, and so on)

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param conditionSetId Either the unique id of the condition set, or the URL-friendly key of the condition set (i.e: the \"slug\").
@return ApiGetConditionSetDescendantsRequest

func (*ConditionSetsApiService) GetConditionSetDescendantsExecute added in v0.0.10

Execute executes the request

@return []ConditionSetRead

func (*ConditionSetsApiService) GetConditionSetExecute

Execute executes the request

@return ConditionSetRead

func (*ConditionSetsApiService) GetConditionSetPossibleParents added in v0.0.10

func (a *ConditionSetsApiService) GetConditionSetPossibleParents(ctx context.Context, projId string, envId string, conditionSetId string) ApiGetConditionSetPossibleParentsRequest

GetConditionSetPossibleParents Get Condition Set Possible Parents

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param conditionSetId Either the unique id of the condition set, or the URL-friendly key of the condition set (i.e: the \"slug\").
@return ApiGetConditionSetPossibleParentsRequest

func (*ConditionSetsApiService) GetConditionSetPossibleParentsExecute added in v0.0.10

Execute executes the request

@return []ConditionSetRead

func (*ConditionSetsApiService) ListConditionSets

func (a *ConditionSetsApiService) ListConditionSets(ctx context.Context, projId string, envId string) ApiListConditionSetsRequest

ListConditionSets List Condition Sets

Lists all condition sets matching a filter.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListConditionSetsRequest

func (*ConditionSetsApiService) ListConditionSetsExecute

Execute executes the request

@return ResponseListConditionSetsV2SchemaProjIdEnvIdConditionSetsGet

Deprecated

func (*ConditionSetsApiService) UpdateConditionSet

func (a *ConditionSetsApiService) UpdateConditionSet(ctx context.Context, projId string, envId string, conditionSetId string) ApiUpdateConditionSetRequest

UpdateConditionSet Update Condition Set

Partially updates a condition set. Fields that will be provided will be completely overwritten.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param conditionSetId Either the unique id of the condition set, or the URL-friendly key of the condition set (i.e: the \"slug\").
@return ApiUpdateConditionSetRequest

func (*ConditionSetsApiService) UpdateConditionSetExecute

Execute executes the request

@return ConditionSetRead

type Configuration

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type DecisionLogsApiService

type DecisionLogsApiService service

DecisionLogsApiService DecisionLogsApi service

func (*DecisionLogsApiService) ListPdpDecisionLogs

func (a *DecisionLogsApiService) ListPdpDecisionLogs(ctx context.Context, projId string, envId string, pdpId string) ApiListPdpDecisionLogsRequest

ListPdpDecisionLogs List PDP Decisions

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param pdpId The unique id of the pdp
@return ApiListPdpDecisionLogsRequest

func (*DecisionLogsApiService) ListPdpDecisionLogsExecute

Execute executes the request

@return PaginatedResultOPADecisionLog

type DecisionLogsIngressApiService

type DecisionLogsIngressApiService service

DecisionLogsIngressApiService DecisionLogsIngressApi service

func (*DecisionLogsIngressApiService) InsertOpaDecisionLogs

InsertOpaDecisionLogs OPA Decision Logs Ingress

This ingress endpoint captures OPA decision logs.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiInsertOpaDecisionLogsRequest

func (*DecisionLogsIngressApiService) InsertOpaDecisionLogsExecute

func (a *DecisionLogsIngressApiService) InsertOpaDecisionLogsExecute(r ApiInsertOpaDecisionLogsRequest) (*http.Response, error)

Execute executes the request

type DefaultApiService

type DefaultApiService service

DefaultApiService DefaultApi service

func (*DefaultApiService) Dummy

Dummy Dummy

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiDummyRequest

func (*DefaultApiService) DummyDb

DummyDb Dummy Db

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiDummyDbRequest

func (*DefaultApiService) DummyDbExecute

func (a *DefaultApiService) DummyDbExecute(r ApiDummyDbRequest) (interface{}, *http.Response, error)

Execute executes the request

@return interface{}

func (*DefaultApiService) DummyExecute

func (a *DefaultApiService) DummyExecute(r ApiDummyRequest) (interface{}, *http.Response, error)

Execute executes the request

@return interface{}

func (*DefaultApiService) GetOrganizationV2StressDbOrganizationGet

func (a *DefaultApiService) GetOrganizationV2StressDbOrganizationGet(ctx context.Context) ApiGetOrganizationV2StressDbOrganizationGetRequest

GetOrganizationV2StressDbOrganizationGet Get Organization

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetOrganizationV2StressDbOrganizationGetRequest

func (*DefaultApiService) GetOrganizationV2StressDbOrganizationGetExecute

func (a *DefaultApiService) GetOrganizationV2StressDbOrganizationGetExecute(r ApiGetOrganizationV2StressDbOrganizationGetRequest) (*models.OrganizationRead, *http.Response, error)

Execute executes the request

@return OrganizationRead

func (*DefaultApiService) GetOrganizationWithAuthn

func (a *DefaultApiService) GetOrganizationWithAuthn(ctx context.Context) ApiGetOrganizationWithAuthnRequest

GetOrganizationWithAuthn Get Organization With Authn

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetOrganizationWithAuthnRequest

func (*DefaultApiService) GetOrganizationWithAuthnExecute

Execute executes the request

@return OrganizationRead

func (*DefaultApiService) GetOrganizationWithAuthz

func (a *DefaultApiService) GetOrganizationWithAuthz(ctx context.Context) ApiGetOrganizationWithAuthzRequest

GetOrganizationWithAuthz Get Organization With Authz

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetOrganizationWithAuthzRequest

func (*DefaultApiService) GetOrganizationWithAuthzExecute

Execute executes the request

@return OrganizationRead

type ElementsConfigsApiService

type ElementsConfigsApiService service

ElementsConfigsApiService ElementsConfigsApi service

func (*ElementsConfigsApiService) CreateElementsConfig

func (a *ElementsConfigsApiService) CreateElementsConfig(ctx context.Context, projId string, envId string) ApiCreateElementsConfigRequest

CreateElementsConfig Create Elements Config

Creates a new elements_config under the active organization.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiCreateElementsConfigRequest

func (*ElementsConfigsApiService) CreateElementsConfigExecute

Execute executes the request

@return ElementsConfigRead

func (*ElementsConfigsApiService) DeleteElementsConfig

func (a *ElementsConfigsApiService) DeleteElementsConfig(ctx context.Context, elementsConfigId string, projId string, envId string) ApiDeleteElementsConfigRequest

DeleteElementsConfig Delete Elements Config

Deletes the elements_config and all its related data.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\").
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiDeleteElementsConfigRequest

func (*ElementsConfigsApiService) DeleteElementsConfigExecute

func (a *ElementsConfigsApiService) DeleteElementsConfigExecute(r ApiDeleteElementsConfigRequest) (*http.Response, error)

Execute executes the request

func (*ElementsConfigsApiService) GetElementsConfig

func (a *ElementsConfigsApiService) GetElementsConfig(ctx context.Context, projId string, envId string, elementsConfigId string) ApiGetElementsConfigRequest

GetElementsConfig Get Elements Config

Gets a single elements_config matching the given elements_config_id, if such elements_config exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\").
@return ApiGetElementsConfigRequest

func (*ElementsConfigsApiService) GetElementsConfigExecute

Execute executes the request

@return ElementsConfigRead

func (*ElementsConfigsApiService) GetEnvConfig

func (a *ElementsConfigsApiService) GetEnvConfig(ctx context.Context, projId string, envId string) ApiGetEnvConfigRequest

GetEnvConfig Get Env Config

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiGetEnvConfigRequest

func (*ElementsConfigsApiService) GetEnvConfigExecute

Execute executes the request

@return ElementsEnvRead

func (*ElementsConfigsApiService) ListElementsConfigs

func (a *ElementsConfigsApiService) ListElementsConfigs(ctx context.Context, projId string, envId string) ApiListElementsConfigsRequest

ListElementsConfigs List Elements Configs

Lists all the elements_configs under the active organization.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListElementsConfigsRequest

func (*ElementsConfigsApiService) ListElementsConfigsExecute

Execute executes the request

@return PaginatedResultElementsConfigRead

func (*ElementsConfigsApiService) UpdateElementsConfig

func (a *ElementsConfigsApiService) UpdateElementsConfig(ctx context.Context, elementsConfigId string, projId string, envId string) ApiUpdateElementsConfigRequest

UpdateElementsConfig Update Elements Config

Updates the elements_config.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\").
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiUpdateElementsConfigRequest

func (*ElementsConfigsApiService) UpdateElementsConfigExecute

Execute executes the request

@return ElementsConfigRead

func (*ElementsConfigsApiService) UpdateElementsEnv

func (a *ElementsConfigsApiService) UpdateElementsEnv(ctx context.Context, projId string, envId string) ApiUpdateElementsEnvRequest

UpdateElementsEnv Update Elements Env

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiUpdateElementsEnvRequest

func (*ElementsConfigsApiService) UpdateElementsEnvExecute

Execute executes the request

@return ElementsEnvRead

type ElementsDataApiService

type ElementsDataApiService service

ElementsDataApiService ElementsDataApi service

func (*ElementsDataApiService) ElementsAssignRoleToUser

func (a *ElementsDataApiService) ElementsAssignRoleToUser(ctx context.Context, projId string, envId string, elementsConfigId string, userId string) ApiElementsAssignRoleToUserRequest

ElementsAssignRoleToUser Assign role to user

Assigns a role to the user within the tenant.

The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\").
@param userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
@return ApiElementsAssignRoleToUserRequest

func (*ElementsDataApiService) ElementsAssignRoleToUserExecute

Execute executes the request

@return RoleAssignmentRead

func (*ElementsDataApiService) ElementsCreateUser

func (a *ElementsDataApiService) ElementsCreateUser(ctx context.Context, projId string, envId string, elementsConfigId string) ApiElementsCreateUserRequest

ElementsCreateUser Create user

Creates a new user inside the Permit.io system, from that point forward you may run permission checks on that user.

If the user is already created: will return 200 instead of 201, and will return the existing user object in the response body.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\").
@return ApiElementsCreateUserRequest

func (*ElementsDataApiService) ElementsCreateUserExecute

Execute executes the request

@return UserRead

func (*ElementsDataApiService) ElementsDeleteUser

func (a *ElementsDataApiService) ElementsDeleteUser(ctx context.Context, projId string, envId string, elementsConfigId string, userId string) ApiElementsDeleteUserRequest

ElementsDeleteUser Delete user

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\").
@param userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
@return ApiElementsDeleteUserRequest

func (*ElementsDataApiService) ElementsDeleteUserExecute

func (a *ElementsDataApiService) ElementsDeleteUserExecute(r ApiElementsDeleteUserRequest) (*http.Response, error)

Execute executes the request

func (*ElementsDataApiService) ElementsListRoles

func (a *ElementsDataApiService) ElementsListRoles(ctx context.Context, projId string, envId string, elementsConfigId string) ApiElementsListRolesRequest

ElementsListRoles List roles

Lists all the users defined within an environment.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\").
@return ApiElementsListRolesRequest

func (*ElementsDataApiService) ElementsListRolesExecute

Execute executes the request

@return []ElementsRoleRead

func (*ElementsDataApiService) ElementsListUsers

func (a *ElementsDataApiService) ElementsListUsers(ctx context.Context, projId string, envId string, elementsConfigId string) ApiElementsListUsersRequest

ElementsListUsers List users

Lists all the users defined within an environment.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\").
@return ApiElementsListUsersRequest

func (*ElementsDataApiService) ElementsListUsersExecute

Execute executes the request

@return PaginatedResultUserRead

func (*ElementsDataApiService) ElementsUnassignRoleFromUser

func (a *ElementsDataApiService) ElementsUnassignRoleFromUser(ctx context.Context, projId string, envId string, elementsConfigId string, userId string) ApiElementsUnassignRoleFromUserRequest

ElementsUnassignRoleFromUser Unassign role from user

Unassigns the role from the user within the tenant.

The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.

If the role is not actually assigned, will return 404.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\").
@param userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
@return ApiElementsUnassignRoleFromUserRequest

func (*ElementsDataApiService) ElementsUnassignRoleFromUserExecute

func (a *ElementsDataApiService) ElementsUnassignRoleFromUserExecute(r ApiElementsUnassignRoleFromUserRequest) (*http.Response, error)

Execute executes the request

func (*ElementsDataApiService) SetConfigActive

func (a *ElementsDataApiService) SetConfigActive(ctx context.Context, elementsConfigId string, projId string, envId string) ApiSetConfigActiveRequest

SetConfigActive Set Config Active

Updates the embed_config.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param elementsConfigId Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\").
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiSetConfigActiveRequest

func (*ElementsDataApiService) SetConfigActiveExecute

func (a *ElementsDataApiService) SetConfigActiveExecute(r ApiSetConfigActiveRequest) (*http.Response, error)

Execute executes the request

type EnvironmentsApiService

type EnvironmentsApiService service

EnvironmentsApiService EnvironmentsApi service

func (*EnvironmentsApiService) CopyEnvironment added in v0.0.10

func (a *EnvironmentsApiService) CopyEnvironment(ctx context.Context, projId string, envId string) ApiCopyEnvironmentRequest

CopyEnvironment Copy Environment

Copy environment

This endpoint either duplicates an existing environment to a new environment in the same project, or copies from an existing environment to another existing environment.

The `scope` object controls which objects will be copied to the target environment.

To clone to a new environment, the user must have write permissions to the containing project. To clone into an existing environment, the user must have write permissions to the target environment.

Copying environments across projects or organizations is not allowed.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiCopyEnvironmentRequest

func (*EnvironmentsApiService) CopyEnvironmentExecute added in v0.0.10

Execute executes the request

@return EnvironmentRead

func (*EnvironmentsApiService) CreateEnvironment

func (a *EnvironmentsApiService) CreateEnvironment(ctx context.Context, projId string) ApiCreateEnvironmentRequest

CreateEnvironment Create Environment

Creates a new environment under a given project.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@return ApiCreateEnvironmentRequest

func (*EnvironmentsApiService) CreateEnvironmentExecute

Execute executes the request

@return EnvironmentRead

func (*EnvironmentsApiService) DeleteEnvironment

func (a *EnvironmentsApiService) DeleteEnvironment(ctx context.Context, projId string, envId string) ApiDeleteEnvironmentRequest

DeleteEnvironment Delete Environment

Deletes an environment and all its related data.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiDeleteEnvironmentRequest

func (*EnvironmentsApiService) DeleteEnvironmentExecute

func (a *EnvironmentsApiService) DeleteEnvironmentExecute(r ApiDeleteEnvironmentRequest) (*http.Response, error)

Execute executes the request

func (*EnvironmentsApiService) GetEnvironment

func (a *EnvironmentsApiService) GetEnvironment(ctx context.Context, projId string, envId string) ApiGetEnvironmentRequest

GetEnvironment Get Environment

Gets a single environment matching the given env_id, if such environment exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiGetEnvironmentRequest

func (*EnvironmentsApiService) GetEnvironmentExecute

Execute executes the request

@return EnvironmentRead

func (*EnvironmentsApiService) ListEnvironments

func (a *EnvironmentsApiService) ListEnvironments(ctx context.Context, projId string) ApiListEnvironmentsRequest

ListEnvironments List Environments

Lists all the environments under a given project.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@return ApiListEnvironmentsRequest

func (*EnvironmentsApiService) ListEnvironmentsExecute

Execute executes the request

@return []EnvironmentRead

func (*EnvironmentsApiService) StatsEnvironments

func (a *EnvironmentsApiService) StatsEnvironments(ctx context.Context, projId string, envId string) ApiStatsEnvironmentsRequest

StatsEnvironments Stats Environments

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiStatsEnvironmentsRequest

func (*EnvironmentsApiService) StatsEnvironmentsExecute

Execute executes the request

@return EnvironmentStats

func (*EnvironmentsApiService) UpdateEnvironment

func (a *EnvironmentsApiService) UpdateEnvironment(ctx context.Context, projId string, envId string) ApiUpdateEnvironmentRequest

UpdateEnvironment Update Environment

Updates the environment.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiUpdateEnvironmentRequest

func (*EnvironmentsApiService) UpdateEnvironmentExecute

Execute executes the request

@return EnvironmentRead

type GenericOpenAPIError

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type ImplicitGrantsAPIService added in v1.0.5

type ImplicitGrantsAPIService service

ImplicitGrantsAPIService ImplicitGrantsAPI service

func (*ImplicitGrantsAPIService) CreateImplicitGrant added in v1.0.5

func (a *ImplicitGrantsAPIService) CreateImplicitGrant(ctx context.Context, projId string, envId string, resourceId string, roleId string) ApiCreateImplicitGrantRequest

CreateImplicitGrant Create Implicit Grant

Creates an implicit grant on a given role

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@return ApiCreateImplicitGrantRequest

func (*ImplicitGrantsAPIService) CreateImplicitGrantExecute added in v1.0.5

Execute executes the request

@return DerivedRoleRuleRead

func (*ImplicitGrantsAPIService) DeleteImplicitGrant added in v1.0.5

func (a *ImplicitGrantsAPIService) DeleteImplicitGrant(ctx context.Context, projId string, envId string, roleId string, resourceId string) ApiDeleteImplicitGrantRequest

DeleteImplicitGrant Delete Implicit Grant

Deletes an implicit grant on a given role

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiDeleteImplicitGrantRequest

func (*ImplicitGrantsAPIService) DeleteImplicitGrantExecute added in v1.0.5

func (a *ImplicitGrantsAPIService) DeleteImplicitGrantExecute(r ApiDeleteImplicitGrantRequest) (*http.Response, error)

Execute executes the request

func (*ImplicitGrantsAPIService) UpdateImplicitGrantsConditions added in v1.0.5

func (a *ImplicitGrantsAPIService) UpdateImplicitGrantsConditions(ctx context.Context, projId string, envId string, resourceId string, roleId string) ApiUpdateImplicitGrantsConditionsRequest

UpdateImplicitGrantsConditions Update Implicit Grants Conditions

Update the `when` for implicit grants on a given role

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@return ApiUpdateImplicitGrantsConditionsRequest

func (*ImplicitGrantsAPIService) UpdateImplicitGrantsConditionsExecute added in v1.0.5

Execute executes the request

@return PermitBackendSchemasSchemaDerivedRoleRuleDerivationSettings

type InstructionsApiService

type InstructionsApiService service

InstructionsApiService InstructionsApi service

func (*InstructionsApiService) ListLanguageInstructions

func (a *InstructionsApiService) ListLanguageInstructions(ctx context.Context, projId string, envId string) ApiListLanguageInstructionsRequest

ListLanguageInstructions List Language Instructions

Lists pending organization invites

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListLanguageInstructionsRequest

func (*InstructionsApiService) ListLanguageInstructionsExecute

Execute executes the request

@return []LanguageInstructions

type MembersApiService

type MembersApiService service

MembersApiService MembersApi service

func (*MembersApiService) DeleteOrganizationMember

func (a *MembersApiService) DeleteOrganizationMember(ctx context.Context, memberId string) ApiDeleteOrganizationMemberRequest

DeleteOrganizationMember Delete Organization Member

Deletes an account member matching the given id or email address. The member will be removed from the active account in permit.io.

If the member is the only member in its account (organization), returns 400 (bad request), due to nobody remains with access to the account, meaning deletion of the entire account (org). To completely remove an account, call DELETE `/orgs/{org}`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param memberId Either the unique id (UUID) of the account member, or the email address of the account member.
@return ApiDeleteOrganizationMemberRequest

func (*MembersApiService) DeleteOrganizationMemberExecute

func (a *MembersApiService) DeleteOrganizationMemberExecute(r ApiDeleteOrganizationMemberRequest) (*http.Response, error)

Execute executes the request

func (*MembersApiService) GetAuthenticatedMember

func (a *MembersApiService) GetAuthenticatedMember(ctx context.Context) ApiGetAuthenticatedMemberRequest

GetAuthenticatedMember Get the authenticated account member

Gets the authenticated account member's details.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetAuthenticatedMemberRequest

func (*MembersApiService) GetAuthenticatedMemberExecute

func (a *MembersApiService) GetAuthenticatedMemberExecute(r ApiGetAuthenticatedMemberRequest) (*models.OrgMemberRead, *http.Response, error)

Execute executes the request

@return OrgMemberRead

func (*MembersApiService) GetOrganizationMember

func (a *MembersApiService) GetOrganizationMember(ctx context.Context, memberId string) ApiGetOrganizationMemberRequest

GetOrganizationMember Get Organization Member

Gets a single account member by its id or email address. matching the given member, if no such member exists under the current active account (organization), returns 404.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param memberId Either the unique id (UUID) of the account member, or the email address of the account member.
@return ApiGetOrganizationMemberRequest

func (*MembersApiService) GetOrganizationMemberExecute

func (a *MembersApiService) GetOrganizationMemberExecute(r ApiGetOrganizationMemberRequest) (*models.OrgMemberRead, *http.Response, error)

Execute executes the request

@return OrgMemberRead

func (*MembersApiService) ListOrganizationMembers

func (a *MembersApiService) ListOrganizationMembers(ctx context.Context) ApiListOrganizationMembersRequest

ListOrganizationMembers List Organization Members

Lists all the account members that have access to the current active account. The active account/organization is determined by the API Key used or by the authenticated session id.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiListOrganizationMembersRequest

func (*MembersApiService) ListOrganizationMembersExecute

func (a *MembersApiService) ListOrganizationMembersExecute(r ApiListOrganizationMembersRequest) ([]models.OrgMemberRead, *http.Response, error)

Execute executes the request

@return []OrgMemberRead

func (*MembersApiService) UpdateOrganizationMember

func (a *MembersApiService) UpdateOrganizationMember(ctx context.Context, memberId string) ApiUpdateOrganizationMemberRequest

UpdateOrganizationMember Update Organization Member

Updates an account member's settings.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param memberId Either the unique id (UUID) of the account member, or the email address of the account member.
@return ApiUpdateOrganizationMemberRequest

func (*MembersApiService) UpdateOrganizationMemberExecute

func (a *MembersApiService) UpdateOrganizationMemberExecute(r ApiUpdateOrganizationMemberRequest) (*models.OrgMemberRead, *http.Response, error)

Execute executes the request

@return OrgMemberRead

type OPALDataApiService

type OPALDataApiService service

OPALDataApiService OPALDataApi service

func (*OPALDataApiService) GetAllData

func (a *OPALDataApiService) GetAllData(ctx context.Context, orgId string, projId string, envId string) ApiGetAllDataRequest

GetAllData Get All Data

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the \"slug\").
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiGetAllDataRequest

func (*OPALDataApiService) GetAllDataExecute

Execute executes the request

@return FullData

func (*OPALDataApiService) GetDataForRole

func (a *OPALDataApiService) GetDataForRole(ctx context.Context, orgId string, projId string, envId string, roleId string) ApiGetDataForRoleRequest

GetDataForRole Get Data For Role

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the \"slug\").
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param roleId
@return ApiGetDataForRoleRequest

func (*OPALDataApiService) GetDataForRoleExecute

func (a *OPALDataApiService) GetDataForRoleExecute(r ApiGetDataForRoleRequest) (*models.RoleData, *http.Response, error)

Execute executes the request

@return RoleData

func (*OPALDataApiService) GetDataForSetRule

func (a *OPALDataApiService) GetDataForSetRule(ctx context.Context, orgId string, projId string, envId string, userSetId string, resourceSetId string) ApiGetDataForSetRuleRequest

GetDataForSetRule Get Data For Set Rule

return permission assignment data between user sets and resource sets (i.e: condition set rules data)

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the \"slug\").
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param userSetId
@param resourceSetId
@return ApiGetDataForSetRuleRequest

func (*OPALDataApiService) GetDataForSetRuleExecute

func (a *OPALDataApiService) GetDataForSetRuleExecute(r ApiGetDataForSetRuleRequest) (*map[string][]string, *http.Response, error)

Execute executes the request

@return map[string][]string

func (*OPALDataApiService) GetDataForUser

func (a *OPALDataApiService) GetDataForUser(ctx context.Context, orgId string, projId string, envId string, userId string) ApiGetDataForUserRequest

GetDataForUser Get Data For User

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the \"slug\").
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param userId
@return ApiGetDataForUserRequest

func (*OPALDataApiService) GetDataForUserExecute

func (a *OPALDataApiService) GetDataForUserExecute(r ApiGetDataForUserRequest) (*models.UserData, *http.Response, error)

Execute executes the request

@return UserData

type OrganizationsApiService

type OrganizationsApiService service

OrganizationsApiService OrganizationsApi service

func (*OrganizationsApiService) CancelInvite

func (a *OrganizationsApiService) CancelInvite(ctx context.Context, orgId string, inviteId string) ApiCancelInviteRequest

CancelInvite Cancel Invite

Cancels an invite that was sent to a new member.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the \"slug\").
@param inviteId Id of the invite to cancel
@return ApiCancelInviteRequest

func (*OrganizationsApiService) CancelInviteExecute

func (a *OrganizationsApiService) CancelInviteExecute(r ApiCancelInviteRequest) (*http.Response, error)

Execute executes the request

func (*OrganizationsApiService) CreateOrganization

CreateOrganization Create Organization

Creates a new organization that will be owned by the authenticated actor (i.e: human team member or api key).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCreateOrganizationRequest

func (*OrganizationsApiService) CreateOrganizationExecute

Execute executes the request

@return OrganizationReadWithAPIKey

func (*OrganizationsApiService) DeleteOrganization

DeleteOrganization Delete Organization

Deletes an organization (Permit.io account) and all its related data.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the \"slug\").
@return ApiDeleteOrganizationRequest

func (*OrganizationsApiService) DeleteOrganizationExecute

func (a *OrganizationsApiService) DeleteOrganizationExecute(r ApiDeleteOrganizationRequest) (*http.Response, error)

Execute executes the request

func (*OrganizationsApiService) GetActiveOrganization

GetActiveOrganization Get Active Organization

Gets a single organization (Permit.io account) matching the given org_id, if such org exists and can be accessed by the authenticated actor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetActiveOrganizationRequest

func (*OrganizationsApiService) GetActiveOrganizationExecute

Execute executes the request

@return OrganizationRead

func (*OrganizationsApiService) GetOrganization

GetOrganization Get Organization

Gets a single organization (Permit.io account) matching the given org_id, if such org exists and can be accessed by the authenticated actor.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the \"slug\").
@return ApiGetOrganizationRequest

func (*OrganizationsApiService) GetOrganizationExecute

Execute executes the request

@return OrganizationRead

func (*OrganizationsApiService) InviteMembersToOrganization

func (a *OrganizationsApiService) InviteMembersToOrganization(ctx context.Context, orgId string) ApiInviteMembersToOrganizationRequest

InviteMembersToOrganization Invite Members To Organization

Invite new members into the organization.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the \"slug\").
@return ApiInviteMembersToOrganizationRequest

func (*OrganizationsApiService) InviteMembersToOrganizationExecute

Execute executes the request

@return MultiInviteResult

func (*OrganizationsApiService) ListOrganizationInvites

func (a *OrganizationsApiService) ListOrganizationInvites(ctx context.Context, orgId string) ApiListOrganizationInvitesRequest

ListOrganizationInvites List Organization Invites

Lists pending organization invites

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the \"slug\").
@return ApiListOrganizationInvitesRequest

func (*OrganizationsApiService) ListOrganizationInvitesExecute

Execute executes the request

@return []InviteRead

func (*OrganizationsApiService) ListOrganizations

ListOrganizations List Organizations

Lists all the organizations that can be accessed by the authenticated actor (i.e: human team member or api key).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiListOrganizationsRequest

func (*OrganizationsApiService) ListOrganizationsExecute

Execute executes the request

@return []OrganizationRead

func (*OrganizationsApiService) UpdateOrganization

UpdateOrganization Update Organization

Updates the organization's profile.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the \"slug\").
@return ApiUpdateOrganizationRequest

func (*OrganizationsApiService) UpdateOrganizationExecute

Execute executes the request

@return OrganizationRead

type PolicyApiService

type PolicyApiService service

PolicyApiService PolicyApi service

func (*PolicyApiService) GetOpalDataSources

func (a *PolicyApiService) GetOpalDataSources(ctx context.Context) ApiGetOpalDataSourcesRequest

GetOpalDataSources Get Opal Data Sources

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetOpalDataSourcesRequest

func (*PolicyApiService) GetOpalDataSourcesExecute

Execute executes the request

@return DataSourceConfig

func (*PolicyApiService) GetOpalDataSourcesOpalDataConfigGet

func (a *PolicyApiService) GetOpalDataSourcesOpalDataConfigGet(ctx context.Context) ApiGetOpalDataSourcesOpalDataConfigGetRequest

GetOpalDataSourcesOpalDataConfigGet Get Opal Data Sources

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetOpalDataSourcesOpalDataConfigGetRequest

func (*PolicyApiService) GetOpalDataSourcesOpalDataConfigGetExecute

func (a *PolicyApiService) GetOpalDataSourcesOpalDataConfigGetExecute(r ApiGetOpalDataSourcesOpalDataConfigGetRequest) (*models.DataSourceConfig, *http.Response, error)

Execute executes the request

@return DataSourceConfig

type PolicyDecisionPointsApiService

type PolicyDecisionPointsApiService service

PolicyDecisionPointsApiService PolicyDecisionPointsApi service

func (*PolicyDecisionPointsApiService) GetAuthenticatingPdpConfigValues

GetAuthenticatingPdpConfigValues Get connected PDP configuration and push state

Gets the configuration values for the currently authenticated PDP container.

The PDP authenticates with an API key scoped to a given Permit.io environment. The system identifies the PDP via its API key and then returns all the configuration values required for the container to run correctly.

The config values returned are considered "overrides", meaning they are overriding any default values given to the container by the user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetAuthenticatingPdpConfigValuesRequest

func (*PolicyDecisionPointsApiService) GetAuthenticatingPdpConfigValuesExecute

Execute executes the request

@return RemoteConfig

func (*PolicyDecisionPointsApiService) GetAuthenticatingPdpConfigValuesLegacy

GetAuthenticatingPdpConfigValuesLegacy Get connected PDP configuration

Gets the configuration values for the currently authenticated PDP container.

The PDP authenticates with an API key scoped to a given Permit.io environment. The system identifies the PDP via its API key and then returns all the configuration values required for the container to run correctly.

The config values returned are considered "overrides", meaning they are overriding any default values given to the container by the user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetAuthenticatingPdpConfigValuesLegacyRequest

func (*PolicyDecisionPointsApiService) GetAuthenticatingPdpConfigValuesLegacyExecute

Execute executes the request

@return RemoteConfig

func (*PolicyDecisionPointsApiService) GetPdpConfigValues

func (a *PolicyDecisionPointsApiService) GetPdpConfigValues(ctx context.Context, projId string, envId string, pdpId string) ApiGetPdpConfigValuesRequest

GetPdpConfigValues Get PDP configuration

Gets the configuration values for the PDP container with id `pdp_id`.

The config values returned are considered "overrides", meaning they are overriding any default values given to the container by the user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param pdpId The unique id of the pdp
@return ApiGetPdpConfigValuesRequest

func (*PolicyDecisionPointsApiService) GetPdpConfigValuesExecute

Execute executes the request

@return RemoteConfig

func (*PolicyDecisionPointsApiService) ListPdpConfigs

ListPdpConfigs List PDP configurations

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListPdpConfigsRequest

func (*PolicyDecisionPointsApiService) ListPdpConfigsExecute

Execute executes the request

@return []PDPConfigRead

func (*PolicyDecisionPointsApiService) RotatePdpApiKey

func (a *PolicyDecisionPointsApiService) RotatePdpApiKey(ctx context.Context, projId string, envId string, pdpId string) ApiRotatePdpApiKeyRequest

RotatePdpApiKey Rotate PDP API Key

Rotates the API key of the PDP container with id `pdp_id`.

The rotation of the API key revokes the old API key and issues a new API key to the PDP.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param pdpId The unique id of the pdp
@return ApiRotatePdpApiKeyRequest

func (*PolicyDecisionPointsApiService) RotatePdpApiKeyExecute

Execute executes the request

@return PDPConfigRead

type PolicyGitRepositoriesApiService

type PolicyGitRepositoriesApiService service

PolicyGitRepositoriesApiService PolicyGitRepositoriesApi service

func (*PolicyGitRepositoriesApiService) ActivatePolicyRepo

func (a *PolicyGitRepositoriesApiService) ActivatePolicyRepo(ctx context.Context, projId string, repoId string) ApiActivatePolicyRepoRequest

ActivatePolicyRepo Activate Policy Repo

Disable the currently active policy repo, this action means to turn off the gitops feature. If there is no active policy repo, this action will do nothing.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param repoId Either the unique id of the policy repo, or the URL-friendly key of the policy repo (i.e: the \"slug\").
@return ApiActivatePolicyRepoRequest

func (*PolicyGitRepositoriesApiService) ActivatePolicyRepoExecute

Execute executes the request

@return ProjectRead

func (*PolicyGitRepositoriesApiService) CreatePolicyRepo

CreatePolicyRepo Create Policy Repo

Creates a new policy repository configuration under a given project. The given repository is created with status 'pending', it will be changed and used as the 'active' repository for the policy only after a successful attempt to use it. The repository main branch must be present in the remote.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@return ApiCreatePolicyRepoRequest

func (*PolicyGitRepositoriesApiService) CreatePolicyRepoExecute

Execute executes the request

@return PolicyRepoRead

func (*PolicyGitRepositoriesApiService) DeletePolicyRepo

DeletePolicyRepo Delete Policy Repo

Deletes an environment and all its related data.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param repoId Either the unique id of the policy repo, or the URL-friendly key of the policy repo (i.e: the \"slug\").
@return ApiDeletePolicyRepoRequest

func (*PolicyGitRepositoriesApiService) DeletePolicyRepoExecute

Execute executes the request

func (*PolicyGitRepositoriesApiService) DisableActivePolicyRepo

DisableActivePolicyRepo Disable Active Policy Repo

Disable the currently active policy repo, this action means to turn off the gitops feature. If there is no active policy repo, this action will do nothing.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@return ApiDisableActivePolicyRepoRequest

func (*PolicyGitRepositoriesApiService) DisableActivePolicyRepoExecute

Execute executes the request

@return ProjectRead

func (*PolicyGitRepositoriesApiService) GetActivePolicyRepo

GetActivePolicyRepo Get Active Policy Repo

Gets the currently active repository, if such repository exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@return ApiGetActivePolicyRepoRequest

func (*PolicyGitRepositoriesApiService) GetActivePolicyRepoExecute

Execute executes the request

@return PolicyRepoRead

func (*PolicyGitRepositoriesApiService) GetPolicyRepo

GetPolicyRepo Get Policy Repo

Gets a single repository matching the given repo_id, if such repository exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param repoId Either the unique id of the policy repo, or the URL-friendly key of the policy repo (i.e: the \"slug\").
@return ApiGetPolicyRepoRequest

func (*PolicyGitRepositoriesApiService) GetPolicyRepoExecute

Execute executes the request

@return PolicyRepoRead

func (*PolicyGitRepositoriesApiService) ListPolicyRepos

ListPolicyRepos List Policy Repos

Lists all the policy repositories under a given project.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@return ApiListPolicyReposRequest

func (*PolicyGitRepositoriesApiService) ListPolicyReposExecute

Execute executes the request

@return []PolicyRepoRead

type ProjectsApiService

type ProjectsApiService service

ProjectsApiService ProjectsApi service

func (*ProjectsApiService) CreateProject

CreateProject Create Project

Creates a new project under the active organization.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCreateProjectRequest

func (*ProjectsApiService) CreateProjectExecute

Execute executes the request

@return ProjectRead

func (*ProjectsApiService) DeleteProject

func (a *ProjectsApiService) DeleteProject(ctx context.Context, projId string) ApiDeleteProjectRequest

DeleteProject Delete Project

Deletes the project and all its related data.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@return ApiDeleteProjectRequest

func (*ProjectsApiService) DeleteProjectExecute

func (a *ProjectsApiService) DeleteProjectExecute(r ApiDeleteProjectRequest) (*http.Response, error)

Execute executes the request

func (*ProjectsApiService) GetProject

func (a *ProjectsApiService) GetProject(ctx context.Context, projId string) ApiGetProjectRequest

GetProject Get Project

Gets a single project matching the given proj_id, if such project exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@return ApiGetProjectRequest

func (*ProjectsApiService) GetProjectExecute

Execute executes the request

@return ProjectRead

func (*ProjectsApiService) ListProjects

ListProjects List Projects

Lists all the projects under the active organization.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiListProjectsRequest

func (*ProjectsApiService) ListProjectsExecute

Execute executes the request

@return []ProjectRead

func (*ProjectsApiService) UpdateProject

func (a *ProjectsApiService) UpdateProject(ctx context.Context, projId string) ApiUpdateProjectRequest

UpdateProject Update Project

Updates the project.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@return ApiUpdateProjectRequest

func (*ProjectsApiService) UpdateProjectExecute

Execute executes the request

@return ProjectRead

type ProxyConfigAPIService added in v1.0.1

type ProxyConfigAPIService service

ProxyConfigAPIService ProxyConfigAPI service

func (*ProxyConfigAPIService) CreateProxyConfig added in v1.0.1

func (a *ProxyConfigAPIService) CreateProxyConfig(ctx context.Context, projId string, envId string) ApiCreateProxyConfigRequest

CreateProxyConfig Create Proxy Config

Creates a new proxy config inside the Permit.io system.

If the proxy config is already created: will return 200 instead of 201, and will return the existing proxy config object in the response body.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiCreateProxyConfigRequest

func (*ProxyConfigAPIService) CreateProxyConfigExecute added in v1.0.1

Execute executes the request

@return ProxyConfigRead

func (*ProxyConfigAPIService) DeleteProxyConfig added in v1.0.1

func (a *ProxyConfigAPIService) DeleteProxyConfig(ctx context.Context, projId string, envId string, proxyConfigId string) ApiDeleteProxyConfigRequest

DeleteProxyConfig Delete Proxy Config

Deletes the proxy config and all its related data.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param proxyConfigId Either the unique id of the proxy config, or the URL-friendly key of the proxy config (i.e: the \"slug\").
@return ApiDeleteProxyConfigRequest

func (*ProxyConfigAPIService) DeleteProxyConfigExecute added in v1.0.1

func (a *ProxyConfigAPIService) DeleteProxyConfigExecute(r ApiDeleteProxyConfigRequest) (*http.Response, error)

Execute executes the request

func (*ProxyConfigAPIService) GetProxyConfig added in v1.0.1

func (a *ProxyConfigAPIService) GetProxyConfig(ctx context.Context, projId string, envId string, proxyConfigId string) ApiGetProxyConfigRequest

GetProxyConfig Get Proxy Config

Gets a proxy config, if such proxy config exists. Otherwise returns 404.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param proxyConfigId Either the unique id of the proxy config, or the URL-friendly key of the proxy config (i.e: the \"slug\").
@return ApiGetProxyConfigRequest

func (*ProxyConfigAPIService) GetProxyConfigExecute added in v1.0.1

Execute executes the request

@return ProxyConfigRead

func (*ProxyConfigAPIService) ListProxyConfigs added in v1.0.1

func (a *ProxyConfigAPIService) ListProxyConfigs(ctx context.Context, projId string, envId string) ApiListProxyConfigsRequest

ListProxyConfigs List Proxy Configs

Lists all the proxy configs defined within an environment.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListProxyConfigsRequest

func (*ProxyConfigAPIService) ListProxyConfigsExecute added in v1.0.1

Execute executes the request

@return []ProxyConfigRead

func (*ProxyConfigAPIService) UpdateProxyConfig added in v1.0.1

func (a *ProxyConfigAPIService) UpdateProxyConfig(ctx context.Context, projId string, envId string, proxyConfigId string) ApiUpdateProxyConfigRequest

UpdateProxyConfig Update Proxy Config

Partially updates the proxy config definition. Fields that will be provided will be completely overwritten.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param proxyConfigId Either the unique id of the proxy config, or the URL-friendly key of the proxy config (i.e: the \"slug\").
@return ApiUpdateProxyConfigRequest

func (*ProxyConfigAPIService) UpdateProxyConfigExecute added in v1.0.1

Execute executes the request

@return ProxyConfigRead

type RelationshipTuplesAPIService added in v1.0.5

type RelationshipTuplesAPIService service

RelationshipTuplesAPIService RelationshipTuplesAPI service

func (*RelationshipTuplesAPIService) BulkCreateRelationshipTuples added in v1.0.5

func (a *RelationshipTuplesAPIService) BulkCreateRelationshipTuples(ctx context.Context, projId string, envId string) ApiBulkCreateRelationshipTuplesRequest

BulkCreateRelationshipTuples Bulk Create Relationship Tuples

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiBulkCreateRelationshipTuplesRequest

func (*RelationshipTuplesAPIService) BulkCreateRelationshipTuplesExecute added in v1.0.5

func (a *RelationshipTuplesAPIService) BulkCreateRelationshipTuplesExecute(r ApiBulkCreateRelationshipTuplesRequest) (map[string]interface{}, *http.Response, error)

Execute executes the request

@return map[string]interface{}

func (*RelationshipTuplesAPIService) BulkDeleteRelationshipTuples added in v1.0.5

func (a *RelationshipTuplesAPIService) BulkDeleteRelationshipTuples(ctx context.Context, projId string, envId string) ApiBulkDeleteRelationshipTuplesRequest

BulkDeleteRelationshipTuples Bulk Delete Relationship Tuples

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiBulkDeleteRelationshipTuplesRequest

func (*RelationshipTuplesAPIService) BulkDeleteRelationshipTuplesExecute added in v1.0.5

func (a *RelationshipTuplesAPIService) BulkDeleteRelationshipTuplesExecute(r ApiBulkDeleteRelationshipTuplesRequest) (map[string]interface{}, *http.Response, error)

Execute executes the request

@return map[string]interface{}

func (*RelationshipTuplesAPIService) CreateRelationshipTuple added in v1.0.5

func (a *RelationshipTuplesAPIService) CreateRelationshipTuple(ctx context.Context, projId string, envId string) ApiCreateRelationshipTupleRequest

CreateRelationshipTuple Create Relationship Tuple

Create a relationship between two resource instances using a relation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiCreateRelationshipTupleRequest

func (*RelationshipTuplesAPIService) CreateRelationshipTupleExecute added in v1.0.5

Execute executes the request

@return RelationshipTupleRead

func (*RelationshipTuplesAPIService) DeleteRelationshipTuple added in v1.0.5

func (a *RelationshipTuplesAPIService) DeleteRelationshipTuple(ctx context.Context, projId string, envId string) ApiDeleteRelationshipTupleRequest

DeleteRelationshipTuple Delete Relationship Tuple

Delete a relationship between two resource instances.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiDeleteRelationshipTupleRequest

func (*RelationshipTuplesAPIService) DeleteRelationshipTupleExecute added in v1.0.5

func (a *RelationshipTuplesAPIService) DeleteRelationshipTupleExecute(r ApiDeleteRelationshipTupleRequest) (*http.Response, error)

Execute executes the request

func (*RelationshipTuplesAPIService) ListRelationshipTuples added in v1.0.5

func (a *RelationshipTuplesAPIService) ListRelationshipTuples(ctx context.Context, projId string, envId string) ApiListRelationshipTuplesRequest

ListRelationshipTuples List Relationship Tuples

Lists the relationship tuples defined within an environment.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListRelationshipTuplesRequest

func (*RelationshipTuplesAPIService) ListRelationshipTuplesExecute added in v1.0.5

Execute executes the request

@return []RelationshipTupleRead

type ResourceActionGroupsApiService added in v0.0.10

type ResourceActionGroupsApiService service

ResourceActionGroupsApiService ResourceActionGroupsApi service

func (*ResourceActionGroupsApiService) CreateResourceActionGroup added in v0.0.10

func (a *ResourceActionGroupsApiService) CreateResourceActionGroup(ctx context.Context, projId string, envId string, resourceId string) ApiCreateResourceActionGroupRequest

CreateResourceActionGroup Create Resource Action Group

Creates a new action group that can affect the resource.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiCreateResourceActionGroupRequest

func (*ResourceActionGroupsApiService) CreateResourceActionGroupExecute added in v0.0.10

Execute executes the request

@return ResourceActionGroupRead

func (*ResourceActionGroupsApiService) DeleteResourceActionGroup added in v0.0.10

func (a *ResourceActionGroupsApiService) DeleteResourceActionGroup(ctx context.Context, projId string, envId string, resourceId string, actionGroupId string) ApiDeleteResourceActionGroupRequest

DeleteResourceActionGroup Delete Resource Action Group

Deletes the action and all its related data. This includes any permissions granted to perform the action.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param actionGroupId Either the unique id of the action group, or the URL-friendly key of the action group (i.e: the \"slug\").
@return ApiDeleteResourceActionGroupRequest

func (*ResourceActionGroupsApiService) DeleteResourceActionGroupExecute added in v0.0.10

func (a *ResourceActionGroupsApiService) DeleteResourceActionGroupExecute(r ApiDeleteResourceActionGroupRequest) (*http.Response, error)

Execute executes the request

func (*ResourceActionGroupsApiService) GetResourceActionGroup added in v0.0.10

func (a *ResourceActionGroupsApiService) GetResourceActionGroup(ctx context.Context, projId string, envId string, resourceId string, actionGroupId string) ApiGetResourceActionGroupRequest

GetResourceActionGroup Get Resource Action Group

Gets a single action group defined on the resource, if such action exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param actionGroupId Either the unique id of the action group, or the URL-friendly key of the action group (i.e: the \"slug\").
@return ApiGetResourceActionGroupRequest

func (*ResourceActionGroupsApiService) GetResourceActionGroupExecute added in v0.0.10

Execute executes the request

@return ResourceActionGroupRead

func (*ResourceActionGroupsApiService) ListResourceActionGroups added in v0.0.10

func (a *ResourceActionGroupsApiService) ListResourceActionGroups(ctx context.Context, projId string, envId string, resourceId string) ApiListResourceActionGroupsRequest

ListResourceActionGroups List Resource Action Groups

Lists all the action groups defined on the resource.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiListResourceActionGroupsRequest

func (*ResourceActionGroupsApiService) ListResourceActionGroupsExecute added in v0.0.10

Execute executes the request

@return []ResourceActionGroupRead

type ResourceActionsApiService

type ResourceActionsApiService service

ResourceActionsApiService ResourceActionsApi service

func (*ResourceActionsApiService) CreateResourceAction

func (a *ResourceActionsApiService) CreateResourceAction(ctx context.Context, projId string, envId string, resourceId string) ApiCreateResourceActionRequest

CreateResourceAction Create Resource Action

Creates a new action that can affect the resource.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiCreateResourceActionRequest

func (*ResourceActionsApiService) CreateResourceActionExecute

Execute executes the request

@return ResourceActionRead

func (*ResourceActionsApiService) DeleteResourceAction

func (a *ResourceActionsApiService) DeleteResourceAction(ctx context.Context, projId string, envId string, resourceId string, actionId string) ApiDeleteResourceActionRequest

DeleteResourceAction Delete Resource Action

Deletes the action and all its related data. This includes any permissions granted to perform the action.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param actionId Either the unique id of the action, or the URL-friendly key of the action (i.e: the \"slug\").
@return ApiDeleteResourceActionRequest

func (*ResourceActionsApiService) DeleteResourceActionExecute

func (a *ResourceActionsApiService) DeleteResourceActionExecute(r ApiDeleteResourceActionRequest) (*http.Response, error)

Execute executes the request

func (*ResourceActionsApiService) GetResourceAction

func (a *ResourceActionsApiService) GetResourceAction(ctx context.Context, projId string, envId string, resourceId string, actionId string) ApiGetResourceActionRequest

GetResourceAction Get Resource Action

Gets a single action defined on the resource, if such action exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param actionId Either the unique id of the action, or the URL-friendly key of the action (i.e: the \"slug\").
@return ApiGetResourceActionRequest

func (*ResourceActionsApiService) GetResourceActionExecute

Execute executes the request

@return ResourceActionRead

func (*ResourceActionsApiService) ListResourceActions

func (a *ResourceActionsApiService) ListResourceActions(ctx context.Context, projId string, envId string, resourceId string) ApiListResourceActionsRequest

ListResourceActions List Resource Actions

Lists all the actions defined on the resource.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiListResourceActionsRequest

func (*ResourceActionsApiService) ListResourceActionsExecute

Execute executes the request

@return []ResourceActionRead

func (*ResourceActionsApiService) UpdateResourceAction

func (a *ResourceActionsApiService) UpdateResourceAction(ctx context.Context, projId string, envId string, resourceId string, actionId string) ApiUpdateResourceActionRequest

UpdateResourceAction Update Resource Action

Partially updates the action defined on a resource. Fields that will be provided will be completely overwritten.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param actionId Either the unique id of the action, or the URL-friendly key of the action (i.e: the \"slug\").
@return ApiUpdateResourceActionRequest

func (*ResourceActionsApiService) UpdateResourceActionExecute

Execute executes the request

@return ResourceActionRead

type ResourceAttributesApiService

type ResourceAttributesApiService service

ResourceAttributesApiService ResourceAttributesApi service

func (*ResourceAttributesApiService) CreateResourceAttribute

func (a *ResourceAttributesApiService) CreateResourceAttribute(ctx context.Context, projId string, envId string, resourceId string) ApiCreateResourceAttributeRequest

CreateResourceAttribute Create Resource Attribute

Creates a new attribute as part of the resource definition.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiCreateResourceAttributeRequest

func (*ResourceAttributesApiService) CreateResourceAttributeExecute

Execute executes the request

@return ResourceAttributeRead

func (*ResourceAttributesApiService) DeleteResourceAttribute

func (a *ResourceAttributesApiService) DeleteResourceAttribute(ctx context.Context, projId string, envId string, resourceId string, attributeId string) ApiDeleteResourceAttributeRequest

DeleteResourceAttribute Delete Resource Attribute

Deletes the attribute and all its related data.

Note: If the attribute is used by policies, removing it will cause the attribute to evaluate as `undefined`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param attributeId Either the unique id of the attribute, or the URL-friendly key of the attribute (i.e: the \"slug\").
@return ApiDeleteResourceAttributeRequest

func (*ResourceAttributesApiService) DeleteResourceAttributeExecute

func (a *ResourceAttributesApiService) DeleteResourceAttributeExecute(r ApiDeleteResourceAttributeRequest) (*http.Response, error)

Execute executes the request

func (*ResourceAttributesApiService) GetResourceAttribute

func (a *ResourceAttributesApiService) GetResourceAttribute(ctx context.Context, projId string, envId string, resourceId string, attributeId string) ApiGetResourceAttributeRequest

GetResourceAttribute Get Resource Attribute

Gets a single attribute defined on the resource, if such attribute exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param attributeId Either the unique id of the attribute, or the URL-friendly key of the attribute (i.e: the \"slug\").
@return ApiGetResourceAttributeRequest

func (*ResourceAttributesApiService) GetResourceAttributeExecute

Execute executes the request

@return ResourceAttributeRead

func (*ResourceAttributesApiService) ListResourceAttributes

func (a *ResourceAttributesApiService) ListResourceAttributes(ctx context.Context, projId string, envId string, resourceId string) ApiListResourceAttributesRequest

ListResourceAttributes List Resource Attributes

Lists all the attributes defined on the resource.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiListResourceAttributesRequest

func (*ResourceAttributesApiService) ListResourceAttributesExecute

Execute executes the request

@return []ResourceAttributeRead

func (*ResourceAttributesApiService) UpdateResourceAttribute

func (a *ResourceAttributesApiService) UpdateResourceAttribute(ctx context.Context, projId string, envId string, resourceId string, attributeId string) ApiUpdateResourceAttributeRequest

UpdateResourceAttribute Update Resource Attribute

Partially updates the attribute defined on a resource. Fields that will be provided will be completely overwritten.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param attributeId Either the unique id of the attribute, or the URL-friendly key of the attribute (i.e: the \"slug\").
@return ApiUpdateResourceAttributeRequest

func (*ResourceAttributesApiService) UpdateResourceAttributeExecute

Execute executes the request

@return ResourceAttributeRead

type ResourceInstancesApiService

type ResourceInstancesApiService service

ResourceInstancesApiService ResourceInstancesAPI service

func (*ResourceInstancesApiService) CreateResourceInstance

func (a *ResourceInstancesApiService) CreateResourceInstance(ctx context.Context, projId string, envId string) ApiCreateResourceInstanceRequest

CreateResourceInstance Create Resource Instance

Creates a new instance inside the Permit.io system.

If the instance is already created: will return 200 instead of 201, and will return the existing instance object in the response body.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiCreateResourceInstanceRequest

func (*ResourceInstancesApiService) CreateResourceInstanceExecute

Execute executes the request

@return ResourceInstanceRead

func (*ResourceInstancesApiService) DeleteResourceInstance

func (a *ResourceInstancesApiService) DeleteResourceInstance(ctx context.Context, projId string, envId string, instanceId string) ApiDeleteResourceInstanceRequest

DeleteResourceInstance Delete Resource Instance

Deletes the instance and all its related data.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param instanceId Either the unique id of the resource instance, or the URL-friendly key of the resource instance (i.e: the \"slug\").
@return ApiDeleteResourceInstanceRequest

func (*ResourceInstancesApiService) DeleteResourceInstanceExecute

func (a *ResourceInstancesApiService) DeleteResourceInstanceExecute(r ApiDeleteResourceInstanceRequest) (*http.Response, error)

Execute executes the request

func (*ResourceInstancesApiService) GetResourceInstance

func (a *ResourceInstancesApiService) GetResourceInstance(ctx context.Context, projId string, envId string, instanceId string) ApiGetResourceInstanceRequest

GetResourceInstance Get Resource Instance

Gets a instance, if such instance exists. Otherwise returns 404.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param instanceId Either the unique id of the resource instance, or the URL-friendly key of the resource instance (i.e: the \"slug\").
@return ApiGetResourceInstanceRequest

func (*ResourceInstancesApiService) GetResourceInstanceExecute

Execute executes the request

@return ResourceInstanceRead

func (*ResourceInstancesApiService) ListResourceInstances

func (a *ResourceInstancesApiService) ListResourceInstances(ctx context.Context, projId string, envId string) ApiListResourceInstancesRequest

ListResourceInstances List Resource Instances

Lists all the resource instances defined within an environment.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListResourceInstancesRequest

func (*ResourceInstancesApiService) ListResourceInstancesExecute

Execute executes the request

@return []ResourceInstanceRead

func (*ResourceInstancesApiService) UpdateResourceInstance

func (a *ResourceInstancesApiService) UpdateResourceInstance(ctx context.Context, projId string, envId string, instanceId string) ApiUpdateResourceInstanceRequest

UpdateResourceInstance Update Resource Instance

Partially updates the instance definition. Fields that will be provided will be completely overwritten.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param instanceId Either the unique id of the resource instance, or the URL-friendly key of the resource instance (i.e: the \"slug\").
@return ApiUpdateResourceInstanceRequest

func (*ResourceInstancesApiService) UpdateResourceInstanceExecute

Execute executes the request

@return ResourceInstanceRead

type ResourceRelationsAPIService added in v1.0.5

type ResourceRelationsAPIService service

ResourceRelationsAPIService ResourceRelationsAPI service

func (*ResourceRelationsAPIService) CreateResourceRelation added in v1.0.5

func (a *ResourceRelationsAPIService) CreateResourceRelation(ctx context.Context, projId string, envId string, resourceId string) ApiCreateResourceRelationRequest

CreateResourceRelation Create Resource Relation

Creates a resource relation to another resource

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiCreateResourceRelationRequest

func (*ResourceRelationsAPIService) CreateResourceRelationExecute added in v1.0.5

Execute executes the request

@return RelationRead

func (*ResourceRelationsAPIService) DeleteResourceRelation added in v1.0.5

func (a *ResourceRelationsAPIService) DeleteResourceRelation(ctx context.Context, projId string, envId string, resourceId string, relationId string) ApiDeleteResourceRelationRequest

DeleteResourceRelation Delete Resource Relation

Deletes a resource relation

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param relationId Either the unique id of the relation, or the URL-friendly key of the relation (i.e: the \"slug\").
@return ApiDeleteResourceRelationRequest

func (*ResourceRelationsAPIService) DeleteResourceRelationExecute added in v1.0.5

func (a *ResourceRelationsAPIService) DeleteResourceRelationExecute(r ApiDeleteResourceRelationRequest) (*http.Response, error)

Execute executes the request

func (*ResourceRelationsAPIService) GetResourceRelation added in v1.0.5

func (a *ResourceRelationsAPIService) GetResourceRelation(ctx context.Context, projId string, envId string, resourceId string, relationId string) ApiGetResourceRelationRequest

GetResourceRelation Get Resource Relation

Get a resource relation

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param relationId Either the unique id of the relation, or the URL-friendly key of the relation (i.e: the \"slug\").
@return ApiGetResourceRelationRequest

func (*ResourceRelationsAPIService) GetResourceRelationExecute added in v1.0.5

Execute executes the request

@return RelationRead

func (*ResourceRelationsAPIService) ListResourceRelations added in v1.0.5

func (a *ResourceRelationsAPIService) ListResourceRelations(ctx context.Context, projId string, envId string, resourceId string) ApiListResourceRelationsRequest

ListResourceRelations List Resource Relations

List relations on a given resource

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiListResourceRelationsRequest

func (*ResourceRelationsAPIService) ListResourceRelationsExecute added in v1.0.5

Execute executes the request

@return PaginatedResultRelationRead

type ResourceRolesApiService

type ResourceRolesApiService service

ResourceRolesApiService ResourceRolesAPI service

func (*ResourceRolesApiService) AddParentResourceRole

func (a *ResourceRolesApiService) AddParentResourceRole(ctx context.Context, projId string, envId string, resourceId string, roleId string, parentRoleId string) ApiAddParentResourceRoleRequest

AddParentResourceRole Add Parent Role

This endpoint is part of the role hierarchy feature.

Makes role with id `role_id` extend the role with id `parent_role_id`. In other words, `role_id` will automatically be assigned any permissions that are granted to `parent_role_id`.

We can say the `role_id` **extends** `parent_role_id` or **inherits** from `parent_role_id`.

If `role_id` is already an ancestor of `parent_role_id`, the request will fail with HTTP 400 to prevent a cycle in the role hierarchy.

Both roles must be defined on the same resource, identified by id `resource_id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@param parentRoleId Either the unique id of the parent role, or the URL-friendly key of the parent role (i.e: the \"slug\").
@return ApiAddParentResourceRoleRequest

func (*ResourceRolesApiService) AddParentResourceRoleExecute

Execute executes the request

@return ResourceRoleRead

func (*ResourceRolesApiService) AssignPermissionsToResourceRole

func (a *ResourceRolesApiService) AssignPermissionsToResourceRole(ctx context.Context, projId string, envId string, resourceId string, roleId string) ApiAssignPermissionsToResourceRoleRequest

AssignPermissionsToResourceRole Assign Permissions to Role

Assign permissions to role.

If some of the permissions specified are already assigned, will skip them.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@return ApiAssignPermissionsToResourceRoleRequest

func (*ResourceRolesApiService) AssignPermissionsToResourceRoleExecute

Execute executes the request

@return ResourceRoleRead

func (*ResourceRolesApiService) CreateResourceRole

func (a *ResourceRolesApiService) CreateResourceRole(ctx context.Context, projId string, envId string, resourceId string) ApiCreateResourceRoleRequest

CreateResourceRole Create Resource Role

Creates a new role associated with the resource.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiCreateResourceRoleRequest

func (*ResourceRolesApiService) CreateResourceRoleExecute

Execute executes the request

@return ResourceRoleRead

func (*ResourceRolesApiService) DeleteResourceRole

func (a *ResourceRolesApiService) DeleteResourceRole(ctx context.Context, projId string, envId string, resourceId string, roleId string) ApiDeleteResourceRoleRequest

DeleteResourceRole Delete Resource Role

Deletes the role and all its related data. This includes any permissions granted to said role.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@return ApiDeleteResourceRoleRequest

func (*ResourceRolesApiService) DeleteResourceRoleExecute

func (a *ResourceRolesApiService) DeleteResourceRoleExecute(r ApiDeleteResourceRoleRequest) (*http.Response, error)

Execute executes the request

func (*ResourceRolesApiService) GetResourceRole

func (a *ResourceRolesApiService) GetResourceRole(ctx context.Context, projId string, envId string, resourceId string, roleId string) ApiGetResourceRoleRequest

GetResourceRole Get Resource Role

Gets a single role defined on the resource, if such role exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@return ApiGetResourceRoleRequest

func (*ResourceRolesApiService) GetResourceRoleAncestors added in v1.0.5

func (a *ResourceRolesApiService) GetResourceRoleAncestors(ctx context.Context, projId string, envId string, resourceId string, roleId string) ApiGetResourceRoleAncestorsRequest

GetResourceRoleAncestors Get Resource Role Ancestors

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@return ApiGetResourceRoleAncestorsRequest

func (*ResourceRolesApiService) GetResourceRoleAncestorsExecute added in v1.0.5

Execute executes the request

@return ResourceRoleList

func (*ResourceRolesApiService) GetResourceRoleDescendants added in v1.0.5

func (a *ResourceRolesApiService) GetResourceRoleDescendants(ctx context.Context, projId string, envId string, resourceId string, roleId string) ApiGetResourceRoleDescendantsRequest

GetResourceRoleDescendants Get Resource Role Descendants

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@return ApiGetResourceRoleDescendantsRequest

func (*ResourceRolesApiService) GetResourceRoleDescendantsExecute added in v1.0.5

Execute executes the request

@return ResourceRoleList

func (*ResourceRolesApiService) GetResourceRoleExecute

Execute executes the request

@return ResourceRoleRead

func (*ResourceRolesApiService) ListResourceRoles

func (a *ResourceRolesApiService) ListResourceRoles(ctx context.Context, projId string, envId string, resourceId string) ApiListResourceRolesRequest

ListResourceRoles List Resource Roles

Lists all the roles defined on the resource.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiListResourceRolesRequest

func (*ResourceRolesApiService) ListResourceRolesExecute

Execute executes the request

@return []ResourceRoleRead

func (*ResourceRolesApiService) RemoveParentResourceRole

func (a *ResourceRolesApiService) RemoveParentResourceRole(ctx context.Context, projId string, envId string, resourceId string, roleId string, parentRoleId string) ApiRemoveParentResourceRoleRequest

RemoveParentResourceRole Remove Parent Role

This endpoint is part of the role hierarchy feature.

Removes `parent_role_id` from the list of parent roles of role with id `role_id`. In other words, `role_id` will no longer be automatically assigned permissions that are granted to `parent_role_id`.

We can say the `role_id` **not longer extends** `parent_role_id` or **no longer inherits** from `parent_role_id`.

Both roles must be defined on the same resource, identified by id `resource_id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@param parentRoleId Either the unique id of the parent role, or the URL-friendly key of the parent role (i.e: the \"slug\").
@return ApiRemoveParentResourceRoleRequest

func (*ResourceRolesApiService) RemoveParentResourceRoleExecute

Execute executes the request

@return ResourceRoleRead

func (*ResourceRolesApiService) RemovePermissionsFromResourceRole

func (a *ResourceRolesApiService) RemovePermissionsFromResourceRole(ctx context.Context, projId string, envId string, resourceId string, roleId string) ApiRemovePermissionsFromResourceRoleRequest

RemovePermissionsFromResourceRole Remove Permissions from Role

Remove permissions from role.

If some of the permissions specified are already unassigned, will skip them.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@return ApiRemovePermissionsFromResourceRoleRequest

func (*ResourceRolesApiService) RemovePermissionsFromResourceRoleExecute

Execute executes the request

@return ResourceRoleRead

func (*ResourceRolesApiService) UpdateResourceRole

func (a *ResourceRolesApiService) UpdateResourceRole(ctx context.Context, projId string, envId string, resourceId string, roleId string) ApiUpdateResourceRoleRequest

UpdateResourceRole Update Resource Role

Partially updates the role defined on a resource. Fields that will be provided will be completely overwritten.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@return ApiUpdateResourceRoleRequest

func (*ResourceRolesApiService) UpdateResourceRoleExecute

Execute executes the request

@return ResourceRoleRead

type ResourcesApiService

type ResourcesApiService service

ResourcesApiService ResourcesApi service

func (*ResourcesApiService) CreateResource

func (a *ResourcesApiService) CreateResource(ctx context.Context, projId string, envId string) ApiCreateResourceRequest

CreateResource Create Resource

Creates a new resource (a type of object you may protect with permissions).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiCreateResourceRequest

func (*ResourcesApiService) CreateResourceExecute

Execute executes the request

@return ResourceRead

func (*ResourcesApiService) DeleteResource

func (a *ResourcesApiService) DeleteResource(ctx context.Context, projId string, envId string, resourceId string) ApiDeleteResourceRequest

DeleteResource Delete Resource

Deletes the resource and all its related data.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiDeleteResourceRequest

func (*ResourcesApiService) DeleteResourceExecute

func (a *ResourcesApiService) DeleteResourceExecute(r ApiDeleteResourceRequest) (*http.Response, error)

Execute executes the request

func (*ResourcesApiService) GetResource

func (a *ResourcesApiService) GetResource(ctx context.Context, projId string, envId string, resourceId string) ApiGetResourceRequest

GetResource Get Resource

Gets a single resource, if such resource exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiGetResourceRequest

func (*ResourcesApiService) GetResourceExecute

Execute executes the request

@return ResourceRead

func (*ResourcesApiService) ListResources

func (a *ResourcesApiService) ListResources(ctx context.Context, projId string, envId string) ApiListResourcesRequest

ListResources List Resources

Lists all the resources defined in your schema.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListResourcesRequest

func (*ResourcesApiService) ListResourcesExecute

Execute executes the request

@return []ResourceRead

func (*ResourcesApiService) ReplaceResource

func (a *ResourcesApiService) ReplaceResource(ctx context.Context, projId string, envId string, resourceId string) ApiReplaceResourceRequest

ReplaceResource Replace Resource

Completely replaces the resource definition.

- If the resource key is changed, all role and permissions assignments for the the resource will be revoked. - If the resource key is unchanged, but some actions are removed or renamed from the resource definition, role and permissions assignments for these actions will be revoked.

TODO: we need to decide if we are auto-revoking, or if we are rejecting the PUT completely while there are permissions that can be affected.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiReplaceResourceRequest

func (*ResourcesApiService) ReplaceResourceExecute

Execute executes the request

@return ResourceRead

func (*ResourcesApiService) UpdateResource

func (a *ResourcesApiService) UpdateResource(ctx context.Context, projId string, envId string, resourceId string) ApiUpdateResourceRequest

UpdateResource Update Resource

Partially updates the resource definition. Fields that will be provided will be completely overwritten.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param resourceId Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the \"slug\").
@return ApiUpdateResourceRequest

func (*ResourcesApiService) UpdateResourceExecute

Execute executes the request

@return ResourceRead

type RoleAssignmentsApiService

type RoleAssignmentsApiService service

RoleAssignmentsApiService RoleAssignmentsAPI service

func (*RoleAssignmentsApiService) AssignRole

func (a *RoleAssignmentsApiService) AssignRole(ctx context.Context, projId string, envId string) ApiAssignRoleRequest

AssignRole Assign Role

Assigns a role to a user within a tenant.

The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiAssignRoleRequest

func (*RoleAssignmentsApiService) AssignRoleExecute

Execute executes the request

@return RoleAssignmentRead

func (*RoleAssignmentsApiService) BulkAssignRole added in v0.0.10

func (a *RoleAssignmentsApiService) BulkAssignRole(ctx context.Context, projId string, envId string) ApiBulkAssignRoleRequest

BulkAssignRole Bulk Assign Role

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiBulkAssignRoleRequest

func (*RoleAssignmentsApiService) BulkAssignRoleExecute added in v0.0.10

Execute executes the request

@return BulkRoleAssignmentReport

func (*RoleAssignmentsApiService) BulkUnassignRole added in v0.0.10

func (a *RoleAssignmentsApiService) BulkUnassignRole(ctx context.Context, projId string, envId string) ApiBulkUnassignRoleRequest

BulkUnassignRole Bulk Unassign Role

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiBulkUnassignRoleRequest

func (*RoleAssignmentsApiService) BulkUnassignRoleExecute added in v0.0.10

Execute executes the request

@return BulkRoleUnAssignmentReport

func (*RoleAssignmentsApiService) ListRoleAssignments

func (a *RoleAssignmentsApiService) ListRoleAssignments(ctx context.Context, projId string, envId string) ApiListRoleAssignmentsRequest

ListRoleAssignments List Role Assignments

Lists the role assignments defined within an environment.

- If the `user` filter is present, will only return the role assignments of that user. - If the `tenant` filter is present, will only return the role assignments in that tenant. - If the `role` filter is present, will only return role assignments that are granting that role.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListRoleAssignmentsRequest

func (*RoleAssignmentsApiService) ListRoleAssignmentsExecute

Execute executes the request

@return ResponseListRoleAssignmentsV2FactsProjIdEnvIdRoleAssignmentsGet

func (*RoleAssignmentsApiService) UnassignRole

func (a *RoleAssignmentsApiService) UnassignRole(ctx context.Context, projId string, envId string) ApiUnassignRoleRequest

UnassignRole Unassign Role

Unassigns a user role within a tenant.

The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.

If the role is not actually assigned, will return 404.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiUnassignRoleRequest

func (*RoleAssignmentsApiService) UnassignRoleExecute

func (a *RoleAssignmentsApiService) UnassignRoleExecute(r ApiUnassignRoleRequest) (*http.Response, error)

Execute executes the request

type RolesApiService

type RolesApiService service

RolesApiService RolesApi service

func (*RolesApiService) AddParentRole

func (a *RolesApiService) AddParentRole(ctx context.Context, projId string, envId string, roleId string, parentRoleId string) ApiAddParentRoleRequest

AddParentRole Add Parent Role

This endpoint is part of the role hierarchy feature.

Makes role with id `role_id` extend the role with id `parent_role_id`. In other words, `role_id` will automatically be assigned any permissions that are granted to `parent_role_id`.

We can say the `role_id` **extends** `parent_role_id` or **inherits** from `parent_role_id`.

If `role_id` is already an ancestor of `parent_role_id`, the request will fail with HTTP 400 to prevent a cycle in the role hierarchy.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@param parentRoleId Either the unique id of the parent role, or the URL-friendly key of the parent role (i.e: the \"slug\").
@return ApiAddParentRoleRequest

func (*RolesApiService) AddParentRoleExecute

func (a *RolesApiService) AddParentRoleExecute(r ApiAddParentRoleRequest) (*models.RoleRead, *http.Response, error)

Execute executes the request

@return RoleRead

func (*RolesApiService) AssignPermissionsToRole

func (a *RolesApiService) AssignPermissionsToRole(ctx context.Context, projId string, envId string, roleId string) ApiAssignPermissionsToRoleRequest

AssignPermissionsToRole Assign Permissions To Role

Assign permissions to role.

If some of the permissions specified are already unassigned, will skip them.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@return ApiAssignPermissionsToRoleRequest

func (*RolesApiService) AssignPermissionsToRoleExecute

func (a *RolesApiService) AssignPermissionsToRoleExecute(r ApiAssignPermissionsToRoleRequest) (*models.RoleRead, *http.Response, error)

Execute executes the request

@return RoleRead

func (*RolesApiService) CreateRole

func (a *RolesApiService) CreateRole(ctx context.Context, projId string, envId string) ApiCreateRoleRequest

CreateRole Create Role

Creates a new tenant role.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiCreateRoleRequest

func (*RolesApiService) CreateRoleExecute

func (a *RolesApiService) CreateRoleExecute(r ApiCreateRoleRequest) (*models.RoleRead, *http.Response, error)

Execute executes the request

@return RoleRead

func (*RolesApiService) DeleteRole

func (a *RolesApiService) DeleteRole(ctx context.Context, projId string, envId string, roleId string) ApiDeleteRoleRequest

DeleteRole Delete Role

Deletes a tenant role and all its related data. This includes any permissions granted to said role.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@return ApiDeleteRoleRequest

func (*RolesApiService) DeleteRoleExecute

func (a *RolesApiService) DeleteRoleExecute(r ApiDeleteRoleRequest) (*http.Response, error)

Execute executes the request

func (*RolesApiService) GetRole

func (a *RolesApiService) GetRole(ctx context.Context, projId string, envId string, roleId string) ApiGetRoleRequest

GetRole Get Role

Gets a single tenant role, if such role exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@return ApiGetRoleRequest

func (*RolesApiService) GetRoleExecute

func (a *RolesApiService) GetRoleExecute(r ApiGetRoleRequest) (*models.RoleRead, *http.Response, error)

Execute executes the request

@return RoleRead

func (*RolesApiService) ListRoles

func (a *RolesApiService) ListRoles(ctx context.Context, projId string, envId string) ApiListRolesRequest

ListRoles List Roles

Lists all tenant roles.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListRolesRequest

func (*RolesApiService) ListRolesExecute

func (a *RolesApiService) ListRolesExecute(r ApiListRolesRequest) ([]models.RoleRead, *http.Response, error)

Execute executes the request

@return []RoleRead

func (*RolesApiService) RemoveParentRole

func (a *RolesApiService) RemoveParentRole(ctx context.Context, projId string, envId string, roleId string, parentRoleId string) ApiRemoveParentRoleRequest

RemoveParentRole Remove Parent Role

This endpoint is part of the role hierarchy feature.

Removes `parent_role_id` from the list of parent roles of role with id `role_id`. In other words, `role_id` will no longer be automatically assigned permissions that are granted to `parent_role_id`.

We can say the `role_id` **not longer extends** `parent_role_id` or **no longer inherits** from `parent_role_id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@param parentRoleId Either the unique id of the parent role, or the URL-friendly key of the parent role (i.e: the \"slug\").
@return ApiRemoveParentRoleRequest

func (*RolesApiService) RemoveParentRoleExecute

func (a *RolesApiService) RemoveParentRoleExecute(r ApiRemoveParentRoleRequest) (*models.RoleRead, *http.Response, error)

Execute executes the request

@return RoleRead

func (*RolesApiService) RemovePermissionsFromRole

func (a *RolesApiService) RemovePermissionsFromRole(ctx context.Context, projId string, envId string, roleId string) ApiRemovePermissionsFromRoleRequest

RemovePermissionsFromRole Remove Permissions From Role

Remove permissions from role.

If some of the permissions specified are already unassigned, will skip them.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@return ApiRemovePermissionsFromRoleRequest

func (*RolesApiService) RemovePermissionsFromRoleExecute

func (a *RolesApiService) RemovePermissionsFromRoleExecute(r ApiRemovePermissionsFromRoleRequest) (*models.RoleRead, *http.Response, error)

Execute executes the request

@return RoleRead

func (*RolesApiService) UpdateRole

func (a *RolesApiService) UpdateRole(ctx context.Context, projId string, envId string, roleId string) ApiUpdateRoleRequest

UpdateRole Update Role

Partially updates a tenant role. Fields that will be provided will be completely overwritten.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param roleId Either the unique id of the role, or the URL-friendly key of the role (i.e: the \"slug\").
@return ApiUpdateRoleRequest

func (*RolesApiService) UpdateRoleExecute

func (a *RolesApiService) UpdateRoleExecute(r ApiUpdateRoleRequest) (*models.RoleRead, *http.Response, error)

Execute executes the request

@return RoleRead

type ServerConfiguration

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type TenantsApiService

type TenantsApiService service

TenantsApiService TenantsApi service

func (*TenantsApiService) CreateTenant

func (a *TenantsApiService) CreateTenant(ctx context.Context, projId string, envId string) ApiCreateTenantRequest

CreateTenant Create Tenant

Creates a new tenant inside the Permit.io system.

If the tenant is already created: will return 200 instead of 201, and will return the existing tenant object in the response body.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiCreateTenantRequest

func (*TenantsApiService) CreateTenantExecute

Execute executes the request

@return TenantRead

func (*TenantsApiService) DeleteTenant

func (a *TenantsApiService) DeleteTenant(ctx context.Context, projId string, envId string, tenantId string) ApiDeleteTenantRequest

DeleteTenant Delete Tenant

Deletes the tenant and all its related data.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param tenantId Either the unique id of the tenant, or the URL-friendly key of the tenant (i.e: the \"slug\").
@return ApiDeleteTenantRequest

func (*TenantsApiService) DeleteTenantExecute

func (a *TenantsApiService) DeleteTenantExecute(r ApiDeleteTenantRequest) (*http.Response, error)

Execute executes the request

func (*TenantsApiService) DeleteTenantUser

func (a *TenantsApiService) DeleteTenantUser(ctx context.Context, projId string, envId string, tenantId string, userId string) ApiDeleteTenantUserRequest

DeleteTenantUser Delete Tenant User

Deletes a user under a tenant.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param tenantId Either the unique id of the tenant, or the URL-friendly key of the tenant (i.e: the \"slug\").
@param userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
@return ApiDeleteTenantUserRequest

func (*TenantsApiService) DeleteTenantUserExecute

func (a *TenantsApiService) DeleteTenantUserExecute(r ApiDeleteTenantUserRequest) (*http.Response, error)

Execute executes the request

func (*TenantsApiService) GetTenant

func (a *TenantsApiService) GetTenant(ctx context.Context, projId string, envId string, tenantId string) ApiGetTenantRequest

GetTenant Get Tenant

Gets a tenant, if such tenant exists. Otherwise returns 404.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param tenantId Either the unique id of the tenant, or the URL-friendly key of the tenant (i.e: the \"slug\").
@return ApiGetTenantRequest

func (*TenantsApiService) GetTenantExecute

Execute executes the request

@return TenantRead

func (*TenantsApiService) ListTenantUsers

func (a *TenantsApiService) ListTenantUsers(ctx context.Context, projId string, tenantId string, envId string) ApiListTenantUsersRequest

ListTenantUsers List Tenant Users

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param tenantId Either the unique id of the tenant, or the URL-friendly key of the tenant (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListTenantUsersRequest

func (*TenantsApiService) ListTenantUsersExecute

Execute executes the request

@return PaginatedResultUserRead

func (*TenantsApiService) ListTenants

func (a *TenantsApiService) ListTenants(ctx context.Context, projId string, envId string) ApiListTenantsRequest

ListTenants List Tenants

Lists all the tenants defined within an environment.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListTenantsRequest

func (*TenantsApiService) ListTenantsExecute

Execute executes the request

@return []TenantRead

func (*TenantsApiService) UpdateTenant

func (a *TenantsApiService) UpdateTenant(ctx context.Context, projId string, envId string, tenantId string) ApiUpdateTenantRequest

UpdateTenant Update Tenant

Partially updates the tenant definition. Fields that will be provided will be completely overwritten.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param tenantId Either the unique id of the tenant, or the URL-friendly key of the tenant (i.e: the \"slug\").
@return ApiUpdateTenantRequest

func (*TenantsApiService) UpdateTenantExecute

Execute executes the request

@return TenantRead

type UserAttributesApiService

type UserAttributesApiService service

UserAttributesApiService UserAttributesApi service

func (*UserAttributesApiService) CreateUserAttribute

func (a *UserAttributesApiService) CreateUserAttribute(ctx context.Context, projId string, envId string) ApiCreateUserAttributeRequest

CreateUserAttribute Create User Attribute

Creates a new attribute for the User resource.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiCreateUserAttributeRequest

func (*UserAttributesApiService) CreateUserAttributeExecute

Execute executes the request

@return ResourceAttributeRead

func (*UserAttributesApiService) DeleteUserAttribute

func (a *UserAttributesApiService) DeleteUserAttribute(ctx context.Context, projId string, envId string, attributeId string) ApiDeleteUserAttributeRequest

DeleteUserAttribute Delete User Attribute

Deletes the attribute and all its related data.

Note: If the attribute is used by policies, removing it will cause the attribute to evaluate as `undefined`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param attributeId Either the unique id of the attribute, or the URL-friendly key of the attribute (i.e: the \"slug\").
@return ApiDeleteUserAttributeRequest

func (*UserAttributesApiService) DeleteUserAttributeExecute

func (a *UserAttributesApiService) DeleteUserAttributeExecute(r ApiDeleteUserAttributeRequest) (*http.Response, error)

Execute executes the request

func (*UserAttributesApiService) GetUserAttribute

func (a *UserAttributesApiService) GetUserAttribute(ctx context.Context, projId string, envId string, attributeId string) ApiGetUserAttributeRequest

GetUserAttribute Get User Attribute

Gets a single attribute defined on the User resource, if such attribute exists.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param attributeId Either the unique id of the attribute, or the URL-friendly key of the attribute (i.e: the \"slug\").
@return ApiGetUserAttributeRequest

func (*UserAttributesApiService) GetUserAttributeExecute

Execute executes the request

@return ResourceAttributeRead

func (*UserAttributesApiService) ListUserAttributes

func (a *UserAttributesApiService) ListUserAttributes(ctx context.Context, projId string, envId string) ApiListUserAttributesRequest

ListUserAttributes List User Attributes

Lists all the attributes defined on the User resource.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListUserAttributesRequest

func (*UserAttributesApiService) ListUserAttributesExecute

Execute executes the request

@return []ResourceAttributeRead

func (*UserAttributesApiService) UpdateUserAttribute

func (a *UserAttributesApiService) UpdateUserAttribute(ctx context.Context, projId string, envId string, attributeId string) ApiUpdateUserAttributeRequest

UpdateUserAttribute Update User Attribute

Partially updates the attribute defined on the User resource. Fields that will be provided will be completely overwritten.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param attributeId Either the unique id of the attribute, or the URL-friendly key of the attribute (i.e: the \"slug\").
@return ApiUpdateUserAttributeRequest

func (*UserAttributesApiService) UpdateUserAttributeExecute

Execute executes the request

@return ResourceAttributeRead

type UsersApiService

type UsersApiService service

UsersApiService UsersApi service

func (*UsersApiService) AssignRoleToUser

func (a *UsersApiService) AssignRoleToUser(ctx context.Context, projId string, envId string, userId string) ApiAssignRoleToUserRequest

AssignRoleToUser Assign Role To User

Assigns a role to the user within the tenant.

The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
@return ApiAssignRoleToUserRequest

func (*UsersApiService) AssignRoleToUserExecute

Execute executes the request

@return RoleAssignmentRead

func (*UsersApiService) CreateUser

func (a *UsersApiService) CreateUser(ctx context.Context, projId string, envId string) ApiCreateUserRequest

CreateUser Create User

Creates a new user inside the Permit.io system, from that point forward you may run permission checks on that user.

If the user is already created: will return 200 instead of 201, and will return the existing user object in the response body.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiCreateUserRequest

func (*UsersApiService) CreateUserExecute

func (a *UsersApiService) CreateUserExecute(r ApiCreateUserRequest) (*models.UserRead, *http.Response, error)

Execute executes the request

@return UserRead

func (*UsersApiService) DeleteUser

func (a *UsersApiService) DeleteUser(ctx context.Context, projId string, envId string, userId string) ApiDeleteUserRequest

DeleteUser Delete User

Deletes the user and all its related data.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
@return ApiDeleteUserRequest

func (*UsersApiService) DeleteUserExecute

func (a *UsersApiService) DeleteUserExecute(r ApiDeleteUserRequest) (*http.Response, error)

Execute executes the request

func (*UsersApiService) GetUser

func (a *UsersApiService) GetUser(ctx context.Context, projId string, envId string, userId string) ApiGetUserRequest

GetUser Get User

Gets a user, if such user exists. Otherwise returns 404.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
@return ApiGetUserRequest

func (*UsersApiService) GetUserExecute

func (a *UsersApiService) GetUserExecute(r ApiGetUserRequest) (*models.UserRead, *http.Response, error)

Execute executes the request

@return UserRead

func (*UsersApiService) ListUsers

func (a *UsersApiService) ListUsers(ctx context.Context, projId string, envId string) ApiListUsersRequest

ListUsers List Users

Lists all the users defined within an environment.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@return ApiListUsersRequest

func (*UsersApiService) ListUsersExecute

Execute executes the request

@return PaginatedResultUserRead

func (*UsersApiService) ReplaceUser

func (a *UsersApiService) ReplaceUser(ctx context.Context, projId string, envId string, userId string) ApiReplaceUserRequest

ReplaceUser Replace User

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
@return ApiReplaceUserRequest

func (*UsersApiService) ReplaceUserExecute

func (a *UsersApiService) ReplaceUserExecute(r ApiReplaceUserRequest) (*models.UserRead, *http.Response, error)

Execute executes the request

@return UserRead

func (*UsersApiService) UnassignRoleFromUser

func (a *UsersApiService) UnassignRoleFromUser(ctx context.Context, projId string, envId string, userId string) ApiUnassignRoleFromUserRequest

UnassignRoleFromUser Unassign Role From User

Unassigns the role from the user within the tenant.

The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.

If the role is not actually assigned, will return 404.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
@return ApiUnassignRoleFromUserRequest

func (*UsersApiService) UnassignRoleFromUserExecute

func (a *UsersApiService) UnassignRoleFromUserExecute(r ApiUnassignRoleFromUserRequest) (*models.UserRead, *http.Response, error)

Execute executes the request

@return UserRead

func (*UsersApiService) UpdateUser

func (a *UsersApiService) UpdateUser(ctx context.Context, projId string, envId string, userId string) ApiUpdateUserRequest

UpdateUser Update User

Partially updates the user definition. Fields that will be provided will be completely overwritten.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
@param envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
@param userId Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
@return ApiUpdateUserRequest

func (*UsersApiService) UpdateUserExecute

func (a *UsersApiService) UpdateUserExecute(r ApiUpdateUserRequest) (*models.UserRead, *http.Response, error)

Execute executes the request

@return UserRead

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL