modulepackage
0.11.0-alpha.0
Repository: https://github.com/ory/keto-client-go.git
Documentation: pkg.go.dev
# README
ory/keto-client-go
This is the official Ory Keto SDK for go.
Please do not make any pull requests against this repository! Its contents are fully auto-generated by the ory/sdk repository. Any changes to this repository will be overwritten on the next CI run!
Installation
package repository is missing, please open an issue about this.
Documentation
Generation
This code base, including this README, is auto-generated using OpenAPI Generator. If you find bugs in the SDK please check if there is an open issue at OpenAPITools/openapi-generator or ory/sdk already before opening an issue here.
Feedback
If you have feedback on how to improve the Ory SDK or are
looking to contribute, please
open an issue in ory/sdk to
discuss your ideas.
Thanks for being a part of the Ory community!
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewCheckOplSyntaxResult instantiates a new CheckOplSyntaxResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCheckOplSyntaxResultWithDefaults instantiates a new CheckOplSyntaxResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCheckPermissionResult instantiates a new CheckPermissionResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCheckPermissionResultWithDefaults instantiates a new CheckPermissionResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewConfiguration returns a new Configuration object.
NewCreateRelationshipBody instantiates a new CreateRelationshipBody object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCreateRelationshipBodyWithDefaults instantiates a new CreateRelationshipBody object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewErrorGeneric instantiates a new ErrorGeneric object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorGenericWithDefaults instantiates a new ErrorGeneric object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExpandedPermissionTree instantiates a new ExpandedPermissionTree object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExpandedPermissionTreeWithDefaults instantiates a new ExpandedPermissionTree object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGenericError instantiates a new GenericError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGenericErrorWithDefaults instantiates a new GenericError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetVersion200Response instantiates a new GetVersion200Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetVersion200ResponseWithDefaults instantiates a new GetVersion200Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewHealthNotReadyStatus instantiates a new HealthNotReadyStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewHealthNotReadyStatusWithDefaults instantiates a new HealthNotReadyStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewHealthStatus instantiates a new HealthStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewHealthStatusWithDefaults instantiates a new HealthStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIsAlive200Response instantiates a new IsAlive200Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIsAlive200ResponseWithDefaults instantiates a new IsAlive200Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIsReady503Response instantiates a new IsReady503Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIsReady503ResponseWithDefaults instantiates a new IsReady503Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNamespace instantiates a new Namespace object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNamespaceWithDefaults instantiates a new Namespace object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewParseError instantiates a new ParseError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewParseErrorWithDefaults instantiates a new ParseError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPostCheckPermissionBody instantiates a new PostCheckPermissionBody object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPostCheckPermissionBodyWithDefaults instantiates a new PostCheckPermissionBody object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPostCheckPermissionOrErrorBody instantiates a new PostCheckPermissionOrErrorBody object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPostCheckPermissionOrErrorBodyWithDefaults instantiates a new PostCheckPermissionOrErrorBody object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRelationQuery instantiates a new RelationQuery object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRelationQueryWithDefaults instantiates a new RelationQuery object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRelationship instantiates a new Relationship object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRelationshipNamespaces instantiates a new RelationshipNamespaces object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRelationshipNamespacesWithDefaults instantiates a new RelationshipNamespaces object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRelationshipPatch instantiates a new RelationshipPatch object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRelationshipPatchWithDefaults instantiates a new RelationshipPatch object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRelationships instantiates a new Relationships object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRelationshipsWithDefaults instantiates a new Relationships object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRelationshipWithDefaults instantiates a new Relationship object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSourcePosition instantiates a new SourcePosition object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSourcePositionWithDefaults instantiates a new SourcePosition object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSubjectSet instantiates a new SubjectSet object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSubjectSetWithDefaults instantiates a new SubjectSet object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewVersion instantiates a new Version object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewVersionWithDefaults instantiates a new Version object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.
# Structs
APIClient manages communication with the Ory Keto API API vv0.11.0-alpha.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
CheckOplSyntaxResult struct for CheckOplSyntaxResult.
CheckPermissionResult The content of the allowed field is mirrored in the HTTP status code.
Configuration stores the configuration of the API client.
CreateRelationshipBody Create Relationship Request Body.
ErrorGeneric The standard Ory JSON API error format.
ExpandedPermissionTree struct for ExpandedPermissionTree.
GenericError struct for GenericError.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GetVersion200Response struct for GetVersion200Response.
HealthNotReadyStatus struct for HealthNotReadyStatus.
HealthStatus struct for HealthStatus.
IsAlive200Response struct for IsAlive200Response.
IsReady503Response struct for IsReady503Response.
No description provided by the author
No description provided by the author
No description provided by the author
Namespace struct for Namespace.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ParseError struct for ParseError.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PostCheckPermissionBody Check Permission using Post Request Body.
PostCheckPermissionOrErrorBody Post Check Permission Or Error Body.
RelationQuery Relation Query.
Relationship Relationship.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RelationshipNamespaces Relationship Namespace List.
RelationshipPatch Payload for patching a relationship.
Relationships Paginated Relationship List.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
SourcePosition struct for SourcePosition.
SubjectSet struct for SubjectSet.
Version struct for Version.
# Interfaces
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
MetadataApiService MetadataApi service.
PermissionApiService PermissionApi service.
RelationshipApiService RelationshipApi service.
ServerConfigurations stores multiple ServerConfiguration items.