apis

package
v0.0.0-...-09a6dbb Latest Latest
Warning

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

 Go to latest Published: Nov 5, 2024 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source 
var (
	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// 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 AccessRecordsApi 

type AccessRecordsApi struct {
	Client *HttpClient
}

AccessRecordsApi AccessRecords service

func (*AccessRecordsApi) CreateClaim 

func (a *AccessRecordsApi) CreateClaim(ctx context.Context) ApiCreateClaimRequest

CreateClaim Create resource Claim

Claim a resource by allowing a user to pick an identifier and receive admin access to that resource if it hasn't already been claimed. This only works for resources specifically marked as <strong>CLAIM</strong>. The result will be a new access record listing that user as the admin for this resource. The resourceUri will be appended to the collection resource uri using a `/` (forward slash) automatically. 

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

func (*AccessRecordsApi) CreateClaimExecute 

func (a *AccessRecordsApi) CreateClaimExecute(r ApiCreateClaimRequest) (map[string]interface{}, *http.Response, error)

Execute executes the request 

@return map[string]interface{}

func (*AccessRecordsApi) CreateRecord 

func (a *AccessRecordsApi) CreateRecord(ctx context.Context) ApiCreateRecordRequest

CreateRecord Create access record

Specify user roles for specific resources. (Records have a maximum size of ~100KB) 

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

func (*AccessRecordsApi) CreateRecordExecute 

func (a *AccessRecordsApi) CreateRecordExecute(r ApiCreateRecordRequest) (*AccessRecord, *http.Response, error)

Execute executes the request 

@return AccessRecord

func (*AccessRecordsApi) CreateRequest 

func (a *AccessRecordsApi) CreateRequest(ctx context.Context) ApiCreateRequestRequest

CreateRequest Create access request

Specify a request in the form of an access record that an admin can approve. 

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

func (*AccessRecordsApi) CreateRequestExecute 

func (a *AccessRecordsApi) CreateRequestExecute(r ApiCreateRequestRequest) (*AccessRequest, *http.Response, error)

Execute executes the request 

@return AccessRequest

func (*AccessRecordsApi) DeleteRecord 

func (a *AccessRecordsApi) DeleteRecord(ctx context.Context, recordId string) ApiDeleteRecordRequest

DeleteRecord Deletes access record

Remove an access record, removing associated permissions from all users in record. If a user has a permission from another record, that permission will not be removed. (Note: This disables the record by changing the status to <strong>DELETED</strong> but not completely remove the record for tracking purposes. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param recordId The identifier of the access record.
@return ApiDeleteRecordRequest

func (*AccessRecordsApi) DeleteRecordExecute 

func (a *AccessRecordsApi) DeleteRecordExecute(r ApiDeleteRecordRequest) (*http.Response, error)

Execute executes the request

func (*AccessRecordsApi) DeleteRequest 

func (a *AccessRecordsApi) DeleteRequest(ctx context.Context, requestId string) ApiDeleteRequestRequest

DeleteRequest Deletes access request

Remove an access request. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param requestId The identifier of the access request.
@return ApiDeleteRequestRequest

func (*AccessRecordsApi) DeleteRequestExecute 

func (a *AccessRecordsApi) DeleteRequestExecute(r ApiDeleteRequestRequest) (*http.Response, error)

Execute executes the request

func (*AccessRecordsApi) GetRecord 

func (a *AccessRecordsApi) GetRecord(ctx context.Context, recordId string) ApiGetRecordRequest

GetRecord Retrieve access record

Access records contain information assigning permissions to users for resources. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param recordId The identifier of the access record.
@return ApiGetRecordRequest

func (*AccessRecordsApi) GetRecordExecute 

func (a *AccessRecordsApi) GetRecordExecute(r ApiGetRecordRequest) (*AccessRecord, *http.Response, error)

Execute executes the request 

@return AccessRecord

func (*AccessRecordsApi) GetRecords 

func (a *AccessRecordsApi) GetRecords(ctx context.Context) ApiGetRecordsRequest

GetRecords List access records

Returns a paginated records list for the account. Only records the user has access to are returned. The results sort order is not stable, on subsequent requests different results may be returned. This query resource is meant for administrative actions only, therefore has a lower rate limit tier than user permissions related resources. Additionally, the results from a query to Access Records may be delayed up to 5 minutes. 

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

func (*AccessRecordsApi) GetRecordsExecute 

func (a *AccessRecordsApi) GetRecordsExecute(r ApiGetRecordsRequest) (*AccessRecordCollection, *http.Response, error)

Execute executes the request 

@return AccessRecordCollection

func (*AccessRecordsApi) GetRequest 

func (a *AccessRecordsApi) GetRequest(ctx context.Context, requestId string) ApiGetRequestRequest

GetRequest Retrieve access request

Access request contain information requesting permissions for users to resources. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param requestId The identifier of the access request.
@return ApiGetRequestRequest

func (*AccessRecordsApi) GetRequestExecute 

func (a *AccessRecordsApi) GetRequestExecute(r ApiGetRequestRequest) (*AccessRequest, *http.Response, error)

Execute executes the request 

@return AccessRequest

func (*AccessRecordsApi) GetRequests 

func (a *AccessRecordsApi) GetRequests(ctx context.Context) ApiGetRequestsRequest

GetRequests List access requests

Returns a paginated request list. Only requests the user has access to are returned. This query resource is meant for administrative actions only, therefore has a lower rate limit tier than user permissions related resources. 

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

func (*AccessRecordsApi) GetRequestsExecute 

func (a *AccessRecordsApi) GetRequestsExecute(r ApiGetRequestsRequest) (*AccessRequestCollection, *http.Response, error)

Execute executes the request 

@return AccessRequestCollection

func (*AccessRecordsApi) RespondToAccessRequest 

func (a *AccessRecordsApi) RespondToAccessRequest(ctx context.Context, requestId string) ApiRespondToAccessRequestRequest

RespondToAccessRequest Approve or deny access request

Updates an access request, approving it or denying it. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param requestId The identifier of the access request.
@return ApiRespondToAccessRequestRequest

func (*AccessRecordsApi) RespondToAccessRequestExecute 

func (a *AccessRecordsApi) RespondToAccessRequestExecute(r ApiRespondToAccessRequestRequest) (*AccessRequest, *http.Response, error)

Execute executes the request 

@return AccessRequest

func (*AccessRecordsApi) UpdateRecord 

func (a *AccessRecordsApi) UpdateRecord(ctx context.Context, recordId string) ApiUpdateRecordRequest

UpdateRecord Update access record

Updates an access record adding or removing user permissions to resources. (Records have a maximum size of ~100KB) 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param recordId The identifier of the access record.
@return ApiUpdateRecordRequest

func (*AccessRecordsApi) UpdateRecordExecute 

func (a *AccessRecordsApi) UpdateRecordExecute(r ApiUpdateRecordRequest) (*http.Response, error)

Execute executes the request

type AccountsApi 

type AccountsApi struct {
	Client *HttpClient
}

AccountsApi Accounts service

func (*AccountsApi) DelegateAuthentication 

func (a *AccountsApi) DelegateAuthentication(ctx context.Context) ApiDelegateAuthenticationRequest

DelegateAuthentication Link external provider

An identity is a JWT subscriber *sub* and issuer *iss*. Only one account my be linked to a particular JWT combination. Allows calling the API with a federated token directly instead of using a client access key. 

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

func (*AccountsApi) DelegateAuthenticationExecute 

func (a *AccountsApi) DelegateAuthenticationExecute(r ApiDelegateAuthenticationRequest) (*http.Response, error)

Execute executes the request

func (*AccountsApi) GetAccount 

func (a *AccountsApi) GetAccount(ctx context.Context, accountId string) ApiGetAccountRequest

GetAccount Retrieve account information

Includes the original configuration information. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param accountId The unique identifier for the account
@return ApiGetAccountRequest

func (*AccountsApi) GetAccountExecute 

func (a *AccountsApi) GetAccountExecute(r ApiGetAccountRequest) (*Account, *http.Response, error)

Execute executes the request 

@return Account

func (*AccountsApi) GetAccountIdentities 

func (a *AccountsApi) GetAccountIdentities(ctx context.Context) ApiGetAccountIdentitiesRequest

GetAccountIdentities List linked external providers

Returns a list of identities linked for this account. 

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

func (*AccountsApi) GetAccountIdentitiesExecute 

func (a *AccountsApi) GetAccountIdentitiesExecute(r ApiGetAccountIdentitiesRequest) (*IdentityCollection, *http.Response, error)

Execute executes the request 

@return IdentityCollection

func (*AccountsApi) GetAccounts 

func (a *AccountsApi) GetAccounts(ctx context.Context) ApiGetAccountsRequest

GetAccounts List user Authress accounts

Returns a list of accounts that the user has access to. 

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

func (*AccountsApi) GetAccountsExecute 

func (a *AccountsApi) GetAccountsExecute(r ApiGetAccountsRequest) (*AccountCollection, *http.Response, error)

Execute executes the request 

@return AccountCollection

type ApiAuthorizeUserRequest 

type ApiAuthorizeUserRequest struct {
	ThisApiHandler *UserPermissionsApi
	// contains filtered or unexported fields
}

func (ApiAuthorizeUserRequest) Execute 

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

type ApiCreateClaimRequest 

type ApiCreateClaimRequest struct {
	ThisApiHandler *AccessRecordsApi
	// contains filtered or unexported fields
}

func (ApiCreateClaimRequest) ClaimRequest 

func (r ApiCreateClaimRequest) ClaimRequest(claimRequest ClaimRequest) ApiCreateClaimRequest

func (ApiCreateClaimRequest) Execute 

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

type ApiCreateClientRequest 

type ApiCreateClientRequest struct {
	ThisApiHandler *ServiceClientsApi
	// contains filtered or unexported fields
}

func (ApiCreateClientRequest) Client 

func (r ApiCreateClientRequest) Client(client Client) ApiCreateClientRequest

func (ApiCreateClientRequest) Execute 

func (r ApiCreateClientRequest) Execute() (*Client, *http.Response, error)

type ApiCreateConnectionRequest 

type ApiCreateConnectionRequest struct {
	ThisApiHandler *ConnectionsApi
	// contains filtered or unexported fields
}

func (ApiCreateConnectionRequest) Connection 

func (r ApiCreateConnectionRequest) Connection(connection Connection) ApiCreateConnectionRequest

func (ApiCreateConnectionRequest) Execute 

func (r ApiCreateConnectionRequest) Execute() (*Connection, *http.Response, error)

type ApiCreateExtensionRequest 

type ApiCreateExtensionRequest struct {
	ThisApiHandler *ExtensionsApi
	// contains filtered or unexported fields
}

func (ApiCreateExtensionRequest) Execute 

func (r ApiCreateExtensionRequest) Execute() (*Extension, *http.Response, error)

func (ApiCreateExtensionRequest) Extension 

func (r ApiCreateExtensionRequest) Extension(extension Extension) ApiCreateExtensionRequest

type ApiCreateGroupRequest 

type ApiCreateGroupRequest struct {
	ThisApiHandler *GroupsApi
	// contains filtered or unexported fields
}

func (ApiCreateGroupRequest) Execute 

func (r ApiCreateGroupRequest) Execute() (*Group, *http.Response, error)

func (ApiCreateGroupRequest) Group 

func (r ApiCreateGroupRequest) Group(group Group) ApiCreateGroupRequest

type ApiCreateInviteRequest 

type ApiCreateInviteRequest struct {
	ThisApiHandler *InvitesApi
	// contains filtered or unexported fields
}

func (ApiCreateInviteRequest) Execute 

func (r ApiCreateInviteRequest) Execute() (*Invite, *http.Response, error)

func (ApiCreateInviteRequest) Invite 

func (r ApiCreateInviteRequest) Invite(invite Invite) ApiCreateInviteRequest

type ApiCreateRecordRequest 

type ApiCreateRecordRequest struct {
	ThisApiHandler *AccessRecordsApi
	// contains filtered or unexported fields
}

func (ApiCreateRecordRequest) AccessRecord 

func (r ApiCreateRecordRequest) AccessRecord(accessRecord AccessRecord) ApiCreateRecordRequest

func (ApiCreateRecordRequest) Execute 

func (r ApiCreateRecordRequest) Execute() (*AccessRecord, *http.Response, error)

type ApiCreateRequestRequest 

type ApiCreateRequestRequest struct {
	ThisApiHandler *AccessRecordsApi
	// contains filtered or unexported fields
}

func (ApiCreateRequestRequest) AccessRequest 

func (r ApiCreateRequestRequest) AccessRequest(accessRequest AccessRequest) ApiCreateRequestRequest

func (ApiCreateRequestRequest) Execute 

func (r ApiCreateRequestRequest) Execute() (*AccessRequest, *http.Response, error)

type ApiCreateRoleRequest 

type ApiCreateRoleRequest struct {
	ThisApiHandler *RolesApi
	// contains filtered or unexported fields
}

func (ApiCreateRoleRequest) Execute 

func (r ApiCreateRoleRequest) Execute() (*Role, *http.Response, error)

func (ApiCreateRoleRequest) Role 

func (r ApiCreateRoleRequest) Role(role Role) ApiCreateRoleRequest

type ApiCreateTenantRequest 

type ApiCreateTenantRequest struct {
	ThisApiHandler *TenantsApi
	// contains filtered or unexported fields
}

func (ApiCreateTenantRequest) Execute 

func (r ApiCreateTenantRequest) Execute() (*Tenant, *http.Response, error)

func (ApiCreateTenantRequest) Tenant 

func (r ApiCreateTenantRequest) Tenant(tenant Tenant) ApiCreateTenantRequest

type ApiDelegateAuthenticationRequest 

type ApiDelegateAuthenticationRequest struct {
	ThisApiHandler *AccountsApi
	// contains filtered or unexported fields
}

func (ApiDelegateAuthenticationRequest) Execute 

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

func (ApiDelegateAuthenticationRequest) IdentityRequest 

func (r ApiDelegateAuthenticationRequest) IdentityRequest(identityRequest IdentityRequest) ApiDelegateAuthenticationRequest

type ApiDelegateUserLoginRequest 

type ApiDelegateUserLoginRequest struct {
	ThisApiHandler *ApplicationsApi
	// contains filtered or unexported fields
}

func (ApiDelegateUserLoginRequest) Execute 

func (r ApiDelegateUserLoginRequest) Execute() (*ApplicationDelegation, *http.Response, error)

type ApiDeleteAccessKeyRequest 

type ApiDeleteAccessKeyRequest struct {
	ThisApiHandler *ServiceClientsApi
	// contains filtered or unexported fields
}

func (ApiDeleteAccessKeyRequest) Execute 

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

type ApiDeleteClientRequest 

type ApiDeleteClientRequest struct {
	ThisApiHandler *ServiceClientsApi
	// contains filtered or unexported fields
}

func (ApiDeleteClientRequest) Execute 

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

type ApiDeleteConnectionRequest 

type ApiDeleteConnectionRequest struct {
	ThisApiHandler *ConnectionsApi
	// contains filtered or unexported fields
}

func (ApiDeleteConnectionRequest) Execute 

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

type ApiDeleteExtensionRequest 

type ApiDeleteExtensionRequest struct {
	ThisApiHandler *ExtensionsApi
	// contains filtered or unexported fields
}

func (ApiDeleteExtensionRequest) Execute 

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

type ApiDeleteGroupRequest 

type ApiDeleteGroupRequest struct {
	ThisApiHandler *GroupsApi
	// contains filtered or unexported fields
}

func (ApiDeleteGroupRequest) Execute 

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

type ApiDeleteInviteRequest 

type ApiDeleteInviteRequest struct {
	ThisApiHandler *InvitesApi
	// contains filtered or unexported fields
}

func (ApiDeleteInviteRequest) Execute 

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

type ApiDeleteRecordRequest 

type ApiDeleteRecordRequest struct {
	ThisApiHandler *AccessRecordsApi
	// contains filtered or unexported fields
}

func (ApiDeleteRecordRequest) Execute 

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

type ApiDeleteRequestRequest 

type ApiDeleteRequestRequest struct {
	ThisApiHandler *AccessRecordsApi
	// contains filtered or unexported fields
}

func (ApiDeleteRequestRequest) Execute 

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

type ApiDeleteRoleRequest 

type ApiDeleteRoleRequest struct {
	ThisApiHandler *RolesApi
	// contains filtered or unexported fields
}

func (ApiDeleteRoleRequest) Execute 

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

type ApiDeleteTenantRequest 

type ApiDeleteTenantRequest struct {
	ThisApiHandler *TenantsApi
	// contains filtered or unexported fields
}

func (ApiDeleteTenantRequest) Execute 

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

type ApiDeleteUserRequest 

type ApiDeleteUserRequest struct {
	ThisApiHandler *UsersApi
	// contains filtered or unexported fields
}

func (ApiDeleteUserRequest) Execute 

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

type ApiGetAccountIdentitiesRequest 

type ApiGetAccountIdentitiesRequest struct {
	ThisApiHandler *AccountsApi
	// contains filtered or unexported fields
}

func (ApiGetAccountIdentitiesRequest) Execute 

func (r ApiGetAccountIdentitiesRequest) Execute() (*IdentityCollection, *http.Response, error)

type ApiGetAccountRequest 

type ApiGetAccountRequest struct {
	ThisApiHandler *AccountsApi
	// contains filtered or unexported fields
}

func (ApiGetAccountRequest) Execute 

func (r ApiGetAccountRequest) Execute() (*Account, *http.Response, error)

type ApiGetAccountsRequest 

type ApiGetAccountsRequest struct {
	ThisApiHandler *AccountsApi
	// contains filtered or unexported fields
}

func (ApiGetAccountsRequest) EarliestCacheTime 

func (r ApiGetAccountsRequest) EarliestCacheTime(earliestCacheTime time.Time) ApiGetAccountsRequest

Ensure the accounts list is not cached before this time.

func (ApiGetAccountsRequest) Execute 

func (r ApiGetAccountsRequest) Execute() (*AccountCollection, *http.Response, error)

type ApiGetClientRequest 

type ApiGetClientRequest struct {
	ThisApiHandler *ServiceClientsApi
	// contains filtered or unexported fields
}

func (ApiGetClientRequest) Execute 

func (r ApiGetClientRequest) Execute() (*Client, *http.Response, error)

type ApiGetClientsRequest 

type ApiGetClientsRequest struct {
	ThisApiHandler *ServiceClientsApi
	// contains filtered or unexported fields
}

func (ApiGetClientsRequest) Cursor 

func (r ApiGetClientsRequest) Cursor(cursor string) ApiGetClientsRequest

Continuation cursor for paging.

func (ApiGetClientsRequest) Execute 

func (r ApiGetClientsRequest) Execute() (*ClientCollection, *http.Response, error)

func (ApiGetClientsRequest) Limit 

func (r ApiGetClientsRequest) Limit(limit int32) ApiGetClientsRequest

Max number of results to return

type ApiGetConnectionCredentialsRequest 

type ApiGetConnectionCredentialsRequest struct {
	ThisApiHandler *ConnectionsApi
	// contains filtered or unexported fields
}

func (ApiGetConnectionCredentialsRequest) Execute 

func (r ApiGetConnectionCredentialsRequest) Execute() (*UserConnectionCredentials, *http.Response, error)

type ApiGetConnectionRequest 

type ApiGetConnectionRequest struct {
	ThisApiHandler *ConnectionsApi
	// contains filtered or unexported fields
}

func (ApiGetConnectionRequest) Execute 

func (r ApiGetConnectionRequest) Execute() (*Connection, *http.Response, error)

type ApiGetConnectionsRequest 

type ApiGetConnectionsRequest struct {
	ThisApiHandler *ConnectionsApi
	// contains filtered or unexported fields
}

func (ApiGetConnectionsRequest) Execute 

func (r ApiGetConnectionsRequest) Execute() (*ConnectionCollection, *http.Response, error)

type ApiGetExtensionRequest 

type ApiGetExtensionRequest struct {
	ThisApiHandler *ExtensionsApi
	// contains filtered or unexported fields
}

func (ApiGetExtensionRequest) Execute 

func (r ApiGetExtensionRequest) Execute() (*Extension, *http.Response, error)

type ApiGetExtensionsRequest 

type ApiGetExtensionsRequest struct {
	ThisApiHandler *ExtensionsApi
	// contains filtered or unexported fields
}

func (ApiGetExtensionsRequest) Cursor 

func (r ApiGetExtensionsRequest) Cursor(cursor string) ApiGetExtensionsRequest

Continuation cursor for paging

func (ApiGetExtensionsRequest) Execute 

func (r ApiGetExtensionsRequest) Execute() (*ExtensionCollection, *http.Response, error)

func (ApiGetExtensionsRequest) Limit 

func (r ApiGetExtensionsRequest) Limit(limit int32) ApiGetExtensionsRequest

Max number of results to return

type ApiGetGroupRequest 

type ApiGetGroupRequest struct {
	ThisApiHandler *GroupsApi
	// contains filtered or unexported fields
}

func (ApiGetGroupRequest) Execute 

func (r ApiGetGroupRequest) Execute() (*Group, *http.Response, error)

type ApiGetGroupsRequest 

type ApiGetGroupsRequest struct {
	ThisApiHandler *GroupsApi
	// contains filtered or unexported fields
}

func (ApiGetGroupsRequest) Cursor 

func (r ApiGetGroupsRequest) Cursor(cursor string) ApiGetGroupsRequest

Continuation cursor for paging

func (ApiGetGroupsRequest) Execute 

func (r ApiGetGroupsRequest) Execute() (*GroupCollection, *http.Response, error)

func (ApiGetGroupsRequest) Filter 

func (r ApiGetGroupsRequest) Filter(filter string) ApiGetGroupsRequest

Filter to search groups by. This is a case insensitive search through every text field.

func (ApiGetGroupsRequest) Limit 

func (r ApiGetGroupsRequest) Limit(limit int32) ApiGetGroupsRequest

Max number of results to return

type ApiGetInviteRequest 

type ApiGetInviteRequest struct {
	ThisApiHandler *InvitesApi
	// contains filtered or unexported fields
}

func (ApiGetInviteRequest) Execute 

func (r ApiGetInviteRequest) Execute() (*Invite, *http.Response, error)

type ApiGetPermissionedResourceRequest 

type ApiGetPermissionedResourceRequest struct {
	ThisApiHandler *ResourcePermissionsApi
	// contains filtered or unexported fields
}

func (ApiGetPermissionedResourceRequest) Execute 

func (r ApiGetPermissionedResourceRequest) Execute() (*PermissionedResource, *http.Response, error)

type ApiGetPermissionedResourcesRequest 

type ApiGetPermissionedResourcesRequest struct {
	ThisApiHandler *ResourcePermissionsApi
	// contains filtered or unexported fields
}

func (ApiGetPermissionedResourcesRequest) Execute 

func (r ApiGetPermissionedResourcesRequest) Execute() (*PermissionedResourceCollection, *http.Response, error)

type ApiGetRecordRequest 

type ApiGetRecordRequest struct {
	ThisApiHandler *AccessRecordsApi
	// contains filtered or unexported fields
}

func (ApiGetRecordRequest) Execute 

func (r ApiGetRecordRequest) Execute() (*AccessRecord, *http.Response, error)

type ApiGetRecordsRequest 

type ApiGetRecordsRequest struct {
	ThisApiHandler *AccessRecordsApi
	// contains filtered or unexported fields
}

func (ApiGetRecordsRequest) Cursor 

func (r ApiGetRecordsRequest) Cursor(cursor string) ApiGetRecordsRequest

Continuation cursor for paging

func (ApiGetRecordsRequest) Execute 

func (r ApiGetRecordsRequest) Execute() (*AccessRecordCollection, *http.Response, error)

func (ApiGetRecordsRequest) Filter 

func (r ApiGetRecordsRequest) Filter(filter string) ApiGetRecordsRequest

Filter to search records by. This is a case insensitive search through every text field.

func (ApiGetRecordsRequest) Limit 

func (r ApiGetRecordsRequest) Limit(limit int32) ApiGetRecordsRequest

Max number of results to return

func (ApiGetRecordsRequest) Status 

func (r ApiGetRecordsRequest) Status(status string) ApiGetRecordsRequest

Filter records by their current status.

type ApiGetRequestRequest 

type ApiGetRequestRequest struct {
	ThisApiHandler *AccessRecordsApi
	// contains filtered or unexported fields
}

func (ApiGetRequestRequest) Execute 

func (r ApiGetRequestRequest) Execute() (*AccessRequest, *http.Response, error)

type ApiGetRequestsRequest 

type ApiGetRequestsRequest struct {
	ThisApiHandler *AccessRecordsApi
	// contains filtered or unexported fields
}

func (ApiGetRequestsRequest) Cursor 

func (r ApiGetRequestsRequest) Cursor(cursor string) ApiGetRequestsRequest

Continuation cursor for paging

func (ApiGetRequestsRequest) Execute 

func (r ApiGetRequestsRequest) Execute() (*AccessRequestCollection, *http.Response, error)

func (ApiGetRequestsRequest) Limit 

func (r ApiGetRequestsRequest) Limit(limit int32) ApiGetRequestsRequest

Max number of results to return

func (ApiGetRequestsRequest) Status 

func (r ApiGetRequestsRequest) Status(status string) ApiGetRequestsRequest

Filter requests by their current status.

type ApiGetResourceUsersRequest 

type ApiGetResourceUsersRequest struct {
	ThisApiHandler *ResourcePermissionsApi
	// contains filtered or unexported fields
}

func (ApiGetResourceUsersRequest) Cursor 

func (r ApiGetResourceUsersRequest) Cursor(cursor string) ApiGetResourceUsersRequest

Continuation cursor for paging

func (ApiGetResourceUsersRequest) Execute 

func (r ApiGetResourceUsersRequest) Execute() (*ResourceUsersCollection, *http.Response, error)

func (ApiGetResourceUsersRequest) Limit 

func (r ApiGetResourceUsersRequest) Limit(limit int32) ApiGetResourceUsersRequest

Max number of results to return

type ApiGetRoleRequest 

type ApiGetRoleRequest struct {
	ThisApiHandler *RolesApi
	// contains filtered or unexported fields
}

func (ApiGetRoleRequest) Execute 

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

type ApiGetRolesRequest 

type ApiGetRolesRequest struct {
	ThisApiHandler *RolesApi
	// contains filtered or unexported fields
}

func (ApiGetRolesRequest) Cursor 

func (r ApiGetRolesRequest) Cursor(cursor string) ApiGetRolesRequest

Continuation cursor for paging.

func (ApiGetRolesRequest) Execute 

func (r ApiGetRolesRequest) Execute() (*RoleCollection, *http.Response, error)

func (ApiGetRolesRequest) Filter 

func (r ApiGetRolesRequest) Filter(filter string) ApiGetRolesRequest

Filter to search roles by. This is a case insensitive search.

func (ApiGetRolesRequest) Limit 

func (r ApiGetRolesRequest) Limit(limit int32) ApiGetRolesRequest

Max number of results to return.

type ApiGetTenantRequest 

type ApiGetTenantRequest struct {
	ThisApiHandler *TenantsApi
	// contains filtered or unexported fields
}

func (ApiGetTenantRequest) Execute 

func (r ApiGetTenantRequest) Execute() (*Tenant, *http.Response, error)

type ApiGetTenantsRequest 

type ApiGetTenantsRequest struct {
	ThisApiHandler *TenantsApi
	// contains filtered or unexported fields
}

func (ApiGetTenantsRequest) Execute 

func (r ApiGetTenantsRequest) Execute() (*TenantCollection, *http.Response, error)

type ApiGetUserPermissionsForResourceRequest 

type ApiGetUserPermissionsForResourceRequest struct {
	ThisApiHandler *UserPermissionsApi
	// contains filtered or unexported fields
}

func (ApiGetUserPermissionsForResourceRequest) Execute 

func (r ApiGetUserPermissionsForResourceRequest) Execute() (*PermissionCollection, *http.Response, error)

type ApiGetUserRequest 

type ApiGetUserRequest struct {
	ThisApiHandler *UsersApi
	// contains filtered or unexported fields
}

func (ApiGetUserRequest) Execute 

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

type ApiGetUserResourcesRequest 

type ApiGetUserResourcesRequest struct {
	ThisApiHandler *UserPermissionsApi
	// contains filtered or unexported fields
}

func (ApiGetUserResourcesRequest) CollectionConfiguration 

func (r ApiGetUserResourcesRequest) CollectionConfiguration(collectionConfiguration string) ApiGetUserResourcesRequest

&#x60;TOP_LEVEL_ONLY&#x60; - returns only directly nested resources under the resourceUri. A query to &#x60;resourceUri&#x3D;Collection&#x60; will return &#x60;Collection/resource_1&#x60;.&lt;br&gt;&#x60;INCLUDE_NESTED&#x60; - will return all sub-resources as well as deeply nested resources that the user has the specified permission to. A query to &#x60;resourceUri&#x3D;Collection&#x60; will return &#x60;Collection/namespaces/ns/resources/resource_1&#x60;.&lt;br&gt;&lt;br&gt;To return matching resources for nested resources, set this parameter to &#x60;INCLUDE_NESTED&#x60;.

func (ApiGetUserResourcesRequest) Cursor 

func (r ApiGetUserResourcesRequest) Cursor(cursor string) ApiGetUserResourcesRequest

Continuation cursor for paging

func (ApiGetUserResourcesRequest) Execute 

func (r ApiGetUserResourcesRequest) Execute() (*UserResourcesCollection, *http.Response, error)

func (ApiGetUserResourcesRequest) Limit 

func (r ApiGetUserResourcesRequest) Limit(limit int32) ApiGetUserResourcesRequest

Max number of results to return

func (ApiGetUserResourcesRequest) Permissions 

func (r ApiGetUserResourcesRequest) Permissions(permissions Action) ApiGetUserResourcesRequest

Permission to check, &#39;*&#39; and scoped permissions can also be checked here. By default if the user has any permission explicitly to a resource, it will be included in the list.

func (ApiGetUserResourcesRequest) ResourceUri 

func (r ApiGetUserResourcesRequest) ResourceUri(resourceUri string) ApiGetUserResourcesRequest

The top level uri path of a resource to query for. Will only match explicit or nested sub-resources. Will not partial match resource names.

type ApiGetUserRolesForResourceRequest 

type ApiGetUserRolesForResourceRequest struct {
	ThisApiHandler *UserPermissionsApi
	// contains filtered or unexported fields
}

func (ApiGetUserRolesForResourceRequest) Execute 

func (r ApiGetUserRolesForResourceRequest) Execute() (*UserRoleCollection, *http.Response, error)

type ApiGetUsersRequest 

type ApiGetUsersRequest struct {
	ThisApiHandler *UsersApi
	// contains filtered or unexported fields
}

func (ApiGetUsersRequest) Cursor 

func (r ApiGetUsersRequest) Cursor(cursor string) ApiGetUsersRequest

Continuation cursor for paging

func (ApiGetUsersRequest) Execute 

func (r ApiGetUsersRequest) Execute() (*UserIdentityCollection, *http.Response, error)

func (ApiGetUsersRequest) Filter 

func (r ApiGetUsersRequest) Filter(filter string) ApiGetUsersRequest

Filter to search users by. This is a case insensitive search through every text field.

func (ApiGetUsersRequest) Limit 

func (r ApiGetUsersRequest) Limit(limit int32) ApiGetUsersRequest

Max number of results to return

func (ApiGetUsersRequest) TenantId 

func (r ApiGetUsersRequest) TenantId(tenantId TenantId) ApiGetUsersRequest

Return only users that are part of the specified tenant. Users can only be part of one tenant, using this parameter will limit returned users that have logged into this tenant.

type ApiLoginRequest 

type ApiLoginRequest struct {
	ThisApiHandler *ExtensionsApi
	// contains filtered or unexported fields
}

func (ApiLoginRequest) ClientId 

func (r ApiLoginRequest) ClientId(clientId string) ApiLoginRequest

The client identifier to constrain the token to.

func (ApiLoginRequest) CodeChallenge 

func (r ApiLoginRequest) CodeChallenge(codeChallenge string) ApiLoginRequest

The PKCE Code challenge generated by the extension UI to secure the code exchange from [RFC 7636](https://datatracker.ietf.org/doc/html/rfc7636).

func (ApiLoginRequest) CodeChallengeMethod 

func (r ApiLoginRequest) CodeChallengeMethod(codeChallengeMethod string) ApiLoginRequest

The method used to generate the code_challenge from the code_verifier. &#x60;code_challenge_method(code_verifier) &#x3D; code_challenge&#x60;

func (ApiLoginRequest) Execute 

func (r ApiLoginRequest) Execute() (*OAuthAuthorizeResponse, *http.Response, error)

func (ApiLoginRequest) RedirectUri 

func (r ApiLoginRequest) RedirectUri(redirectUri string) ApiLoginRequest

The location to redirect the user back to after login. This redirect_uri must be a URL that matches one of the preconfigured urls in the Authress Application.

type ApiRequestAccessKeyRequest 

type ApiRequestAccessKeyRequest struct {
	ThisApiHandler *ServiceClientsApi
	// contains filtered or unexported fields
}

func (ApiRequestAccessKeyRequest) Execute 

func (r ApiRequestAccessKeyRequest) Execute() (*ClientAccessKey, *http.Response, error)

type ApiRequestTokenRequest 

type ApiRequestTokenRequest struct {
	ThisApiHandler *ExtensionsApi
	// contains filtered or unexported fields
}

func (ApiRequestTokenRequest) Execute 

func (r ApiRequestTokenRequest) Execute() (*OAuthTokenResponse, *http.Response, error)

func (ApiRequestTokenRequest) OAuthTokenRequest 

func (r ApiRequestTokenRequest) OAuthTokenRequest(oAuthTokenRequest OAuthTokenRequest) ApiRequestTokenRequest

The contents of an OAuth token request.

type ApiRespondToAccessRequestRequest 

type ApiRespondToAccessRequestRequest struct {
	ThisApiHandler *AccessRecordsApi
	// contains filtered or unexported fields
}

func (ApiRespondToAccessRequestRequest) AccessRequestResponse 

func (r ApiRespondToAccessRequestRequest) AccessRequestResponse(accessRequestResponse AccessRequestResponse) ApiRespondToAccessRequestRequest

func (ApiRespondToAccessRequestRequest) Execute 

func (r ApiRespondToAccessRequestRequest) Execute() (*AccessRequest, *http.Response, error)

type ApiRespondToInviteRequest 

type ApiRespondToInviteRequest struct {
	ThisApiHandler *InvitesApi
	// contains filtered or unexported fields
}

func (ApiRespondToInviteRequest) Execute 

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

type ApiUpdateClientRequest 

type ApiUpdateClientRequest struct {
	ThisApiHandler *ServiceClientsApi
	// contains filtered or unexported fields
}

func (ApiUpdateClientRequest) Client 

func (r ApiUpdateClientRequest) Client(client Client) ApiUpdateClientRequest

func (ApiUpdateClientRequest) Execute 

func (r ApiUpdateClientRequest) Execute() (*Client, *http.Response, error)

type ApiUpdateConnectionRequest 

type ApiUpdateConnectionRequest struct {
	ThisApiHandler *ConnectionsApi
	// contains filtered or unexported fields
}

func (ApiUpdateConnectionRequest) Connection 

func (r ApiUpdateConnectionRequest) Connection(connection Connection) ApiUpdateConnectionRequest

func (ApiUpdateConnectionRequest) Execute 

func (r ApiUpdateConnectionRequest) Execute() (*Connection, *http.Response, error)

type ApiUpdateExtensionRequest 

type ApiUpdateExtensionRequest struct {
	ThisApiHandler *ExtensionsApi
	// contains filtered or unexported fields
}

func (ApiUpdateExtensionRequest) Execute 

func (r ApiUpdateExtensionRequest) Execute() (*Extension, *http.Response, error)

func (ApiUpdateExtensionRequest) Extension 

func (r ApiUpdateExtensionRequest) Extension(extension Extension) ApiUpdateExtensionRequest

type ApiUpdateGroupRequest 

type ApiUpdateGroupRequest struct {
	ThisApiHandler *GroupsApi
	// contains filtered or unexported fields
}

func (ApiUpdateGroupRequest) Execute 

func (r ApiUpdateGroupRequest) Execute() (*Group, *http.Response, error)

func (ApiUpdateGroupRequest) Group 

func (r ApiUpdateGroupRequest) Group(group Group) ApiUpdateGroupRequest

func (ApiUpdateGroupRequest) IfUnmodifiedSince 

func (r ApiUpdateGroupRequest) IfUnmodifiedSince(ifUnmodifiedSince time.Time) ApiUpdateGroupRequest

The expected last time the group was modified.

type ApiUpdatePermissionedResourceRequest 

type ApiUpdatePermissionedResourceRequest struct {
	ThisApiHandler *ResourcePermissionsApi
	// contains filtered or unexported fields
}

func (ApiUpdatePermissionedResourceRequest) Execute 

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

func (ApiUpdatePermissionedResourceRequest) PermissionedResource 

func (r ApiUpdatePermissionedResourceRequest) PermissionedResource(permissionedResource PermissionedResource) ApiUpdatePermissionedResourceRequest

The contents of the permission to set on the resource. Overwrites existing data.

type ApiUpdateRecordRequest 

type ApiUpdateRecordRequest struct {
	ThisApiHandler *AccessRecordsApi
	// contains filtered or unexported fields
}

func (ApiUpdateRecordRequest) AccessRecord 

func (r ApiUpdateRecordRequest) AccessRecord(accessRecord AccessRecord) ApiUpdateRecordRequest

func (ApiUpdateRecordRequest) Execute 

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

func (ApiUpdateRecordRequest) IfUnmodifiedSince 

func (r ApiUpdateRecordRequest) IfUnmodifiedSince(ifUnmodifiedSince time.Time) ApiUpdateRecordRequest

The expected last time the record was modified.

type ApiUpdateRoleRequest 

type ApiUpdateRoleRequest struct {
	ThisApiHandler *RolesApi
	// contains filtered or unexported fields
}

func (ApiUpdateRoleRequest) Execute 

func (r ApiUpdateRoleRequest) Execute() (*Role, *http.Response, error)

func (ApiUpdateRoleRequest) Role 

func (r ApiUpdateRoleRequest) Role(role Role) ApiUpdateRoleRequest

type ApiUpdateTenantRequest 

type ApiUpdateTenantRequest struct {
	ThisApiHandler *TenantsApi
	// contains filtered or unexported fields
}

func (ApiUpdateTenantRequest) Execute 

func (r ApiUpdateTenantRequest) Execute() (*Tenant, *http.Response, error)

func (ApiUpdateTenantRequest) Tenant 

func (r ApiUpdateTenantRequest) Tenant(tenant Tenant) ApiUpdateTenantRequest

type ApplicationsApi 

type ApplicationsApi struct {
	Client *HttpClient
}

ApplicationsApi Applications service

func (*ApplicationsApi) DelegateUserLogin 

func (a *ApplicationsApi) DelegateUserLogin(ctx context.Context, applicationId string, userId UserId) ApiDelegateUserLoginRequest

DelegateUserLogin Log user into third-party application

Redirect the user to an external application to login them in. Authress uses OpenID and SAML configuration to securely pass the user's login session in your platform to an external platform. The user will then be logged into that platform. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param applicationId The application to have the user log into.
@param userId The user.
@return ApiDelegateUserLoginRequest

func (*ApplicationsApi) DelegateUserLoginExecute 

func (a *ApplicationsApi) DelegateUserLoginExecute(r ApiDelegateUserLoginRequest) (*ApplicationDelegation, *http.Response, error)

Execute executes the request 

@return ApplicationDelegation

type Configuration 

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

Configuration stores the configuration of the API client

func (*Configuration) ServerURLWithContext 

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

ServerURLWithContext returns a new server URL given an endpoint

type ConnectionsApi 

type ConnectionsApi struct {
	Client *HttpClient
}

ConnectionsApi Connections service

func (*ConnectionsApi) CreateConnection 

func (a *ConnectionsApi) CreateConnection(ctx context.Context) ApiCreateConnectionRequest

CreateConnection Create SSO connection

Specify identity connection details for Authress identity aggregation. 

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

func (*ConnectionsApi) CreateConnectionExecute 

func (a *ConnectionsApi) CreateConnectionExecute(r ApiCreateConnectionRequest) (*Connection, *http.Response, error)

Execute executes the request 

@return Connection

func (*ConnectionsApi) DeleteConnection 

func (a *ConnectionsApi) DeleteConnection(ctx context.Context, connectionId string) ApiDeleteConnectionRequest

DeleteConnection Delete SSO connection

Delete an identity connection details for Authress identity aggregation. 

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

func (*ConnectionsApi) DeleteConnectionExecute 

func (a *ConnectionsApi) DeleteConnectionExecute(r ApiDeleteConnectionRequest) (*http.Response, error)

Execute executes the request

func (*ConnectionsApi) GetConnection 

func (a *ConnectionsApi) GetConnection(ctx context.Context, connectionId string) ApiGetConnectionRequest

GetConnection Retrieve SSO connection

Get the identity connection details for Authress identity aggregation. 

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

func (*ConnectionsApi) GetConnectionCredentials 

func (a *ConnectionsApi) GetConnectionCredentials(ctx context.Context, connectionId string, userId UserId) ApiGetConnectionCredentialsRequest

GetConnectionCredentials Retrieve user connection credentials

Get the credentials for the user that were generated as part of the latest user login flow. Returns an access token that can be used with originating connection provider, based on the original scopes and approved permissions by that service. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param connectionId The connection identifier.
@param userId The connection user.
@return ApiGetConnectionCredentialsRequest

func (*ConnectionsApi) GetConnectionCredentialsExecute 

func (a *ConnectionsApi) GetConnectionCredentialsExecute(r ApiGetConnectionCredentialsRequest) (*UserConnectionCredentials, *http.Response, error)

Execute executes the request 

@return UserConnectionCredentials

func (*ConnectionsApi) GetConnectionExecute 

func (a *ConnectionsApi) GetConnectionExecute(r ApiGetConnectionRequest) (*Connection, *http.Response, error)

Execute executes the request 

@return Connection

func (*ConnectionsApi) GetConnections 

func (a *ConnectionsApi) GetConnections(ctx context.Context) ApiGetConnectionsRequest

GetConnections List SSO connections

Returns a paginated connection list for the account. Only connections the user has access to are returned. 

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

func (*ConnectionsApi) GetConnectionsExecute 

func (a *ConnectionsApi) GetConnectionsExecute(r ApiGetConnectionsRequest) (*ConnectionCollection, *http.Response, error)

Execute executes the request 

@return ConnectionCollection

func (*ConnectionsApi) UpdateConnection 

func (a *ConnectionsApi) UpdateConnection(ctx context.Context, connectionId string) ApiUpdateConnectionRequest

UpdateConnection Update SSO connection

Specify identity connection details for Authress identity aggregation. 

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

func (*ConnectionsApi) UpdateConnectionExecute 

func (a *ConnectionsApi) UpdateConnectionExecute(r ApiUpdateConnectionRequest) (*Connection, *http.Response, error)

Execute executes the request 

@return Connection

type ExtensionsApi 

type ExtensionsApi struct {
	Client *HttpClient
}

ExtensionsApi Extensions service

func (*ExtensionsApi) CreateExtension 

func (a *ExtensionsApi) CreateExtension(ctx context.Context) ApiCreateExtensionRequest

CreateExtension Create extension

Specify the extension details for a new developer extension. Creating the extension enables developers to build applications that can log in to your platform and interact with your users' data. 

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

func (*ExtensionsApi) CreateExtensionExecute 

func (a *ExtensionsApi) CreateExtensionExecute(r ApiCreateExtensionRequest) (*Extension, *http.Response, error)

Execute executes the request 

@return Extension

func (*ExtensionsApi) DeleteExtension 

func (a *ExtensionsApi) DeleteExtension(ctx context.Context, extensionId string) ApiDeleteExtensionRequest

DeleteExtension Delete extension

Deletes the specified extension. When deleted an extension can no longer be accessed. Additionally users cannot use that extension to log in, nor can the service client associated with the extension be used to access data secured by Authress. The related Access Records will automatically be deleted. 

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

func (*ExtensionsApi) DeleteExtensionExecute 

func (a *ExtensionsApi) DeleteExtensionExecute(r ApiDeleteExtensionRequest) (*http.Response, error)

Execute executes the request

func (*ExtensionsApi) GetExtension 

func (a *ExtensionsApi) GetExtension(ctx context.Context, extensionId string) ApiGetExtensionRequest

GetExtension Retrieve extension

Gets the platform extension details for the existing extension. 

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

func (*ExtensionsApi) GetExtensionExecute 

func (a *ExtensionsApi) GetExtensionExecute(r ApiGetExtensionRequest) (*Extension, *http.Response, error)

Execute executes the request 

@return Extension

func (*ExtensionsApi) GetExtensions 

func (a *ExtensionsApi) GetExtensions(ctx context.Context) ApiGetExtensionsRequest

GetExtensions List extensions

Lists the platform extensions. Extensions are the applications that developers of your platform have created for your users to interact with. Returns a paginated extension list for the account. Only extensions the user has access to are returned. 

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

func (*ExtensionsApi) GetExtensionsExecute 

func (a *ExtensionsApi) GetExtensionsExecute(r ApiGetExtensionsRequest) (*ExtensionCollection, *http.Response, error)

Execute executes the request 

@return ExtensionCollection

func (*ExtensionsApi) Login 

func (a *ExtensionsApi) Login(ctx context.Context) ApiLoginRequest

Login OAuth Authorize

*Note*: This endpoint is only to be used for [Authress Platform Extensions](https://authress.io/knowledge-base/docs/extensions/). If you are not building an app marketplace, then tokens can be directly requested for Service Clients, using the relevant [SDK](https://authress.io/app/#/api).<br><br>Start the OAuth login by redirecting the user to the OAuth Authorize endpoint. This generates a JWT for the user using the configured application, client ID, and connection.<br><br>The OAuth 2.1 authorization request that follows [RFC 6749](https://www.rfc-editor.org/rfc/rfc6749). Enables users to request a JWT signed by Authress and Returns an OAuth JWT containing the relevant user claims. Tokens generated must be verified before usage by validating the `sub`, `iss`, and `aud` properties in the JWT. Please note, that the properties in the request and response use snake_case to explicitly follow the standard.<br><br>The ExtensionClient in the [@authress/login](https://github.com/Authress/authress-login.js#platform-extension-login) npm package provides all the necessary logic to make this easy. 

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

func (*ExtensionsApi) LoginExecute 

func (a *ExtensionsApi) LoginExecute(r ApiLoginRequest) (*OAuthAuthorizeResponse, *http.Response, error)

Execute executes the request 

@return OAuthAuthorizeResponse

func (*ExtensionsApi) RequestToken 

func (a *ExtensionsApi) RequestToken(ctx context.Context) ApiRequestTokenRequest

RequestToken OAuth Token 

*Note*: This endpoint is only to be used for [Authress Platform Extensions](https://authress.io/knowledge-base/docs/extensions/). If you are not building an app marketplace, then tokens can be directly requested for Service Clients, using the relevant [SDK](https://authress.io/app/#/api).<br><br>Request an OAuth JWT. Can either be called with service client credentials or as the second part of the user authorize login flow.<br>When using the `password` grant_struct,  {
    Client *HttpClient
} client authentication must be used via the Authress SDKs, and requires the `Authress:AuthenticateUser` role.<br><br>The OAuth 2.1 token request that follows [RFC 6749](https://www.rfc-editor.org/rfc/rfc6749). Enables users to request a JWT signed by Authress, and returns an OAuth JWT containing the relevant user claims. Tokens generated must be verified before usage by validating the `sub`, `iss`, and `aud` properties in the JWT. Please note, that the properties in the request and response use snake_case to explicitly follow the standard.<br><br>The ExtensionClient in the [@authress/login](https://github.com/Authress/authress-login.js#platform-extension-login) npm package provides all the necessary logic to make this easy.

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

func (*ExtensionsApi) RequestTokenExecute 

func (a *ExtensionsApi) RequestTokenExecute(r ApiRequestTokenRequest) (*OAuthTokenResponse, *http.Response, error)

Execute executes the request 

@return OAuthTokenResponse

func (*ExtensionsApi) UpdateExtension 

func (a *ExtensionsApi) UpdateExtension(ctx context.Context, extensionId string) ApiUpdateExtensionRequest

UpdateExtension Update extension

Specify the updated extension. The extension will be updated and these changes will be reflected to the access control and user authentication associated with the extension. 

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

func (*ExtensionsApi) UpdateExtensionExecute 

func (a *ExtensionsApi) UpdateExtensionExecute(r ApiUpdateExtensionRequest) (*Extension, *http.Response, error)

Execute executes the request 

@return Extension

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 GroupsApi 

type GroupsApi struct {
	Client *HttpClient
}

GroupsApi Groups service

func (*GroupsApi) CreateGroup 

func (a *GroupsApi) CreateGroup(ctx context.Context) ApiCreateGroupRequest

CreateGroup Create group

Specify users to be included in a new group. (Groups have a maximum size of ~100KB) 

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

func (*GroupsApi) CreateGroupExecute 

func (a *GroupsApi) CreateGroupExecute(r ApiCreateGroupRequest) (*Group, *http.Response, error)

Execute executes the request 

@return Group

func (*GroupsApi) DeleteGroup 

func (a *GroupsApi) DeleteGroup(ctx context.Context, groupId GroupId) ApiDeleteGroupRequest

DeleteGroup Deletes group

Remove a group, users will lose any role that was assigned through membership of this group. This action cannot be undone. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId The identifier of the group.
@return ApiDeleteGroupRequest

func (*GroupsApi) DeleteGroupExecute 

func (a *GroupsApi) DeleteGroupExecute(r ApiDeleteGroupRequest) (*http.Response, error)

Execute executes the request

func (*GroupsApi) GetGroup 

func (a *GroupsApi) GetGroup(ctx context.Context, groupId GroupId) ApiGetGroupRequest

GetGroup Retrieve group

A group contains multiple users which can be added to an access record, and should be assigned the same roles at the same time. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId The identifier of the group.
@return ApiGetGroupRequest

func (*GroupsApi) GetGroupExecute 

func (a *GroupsApi) GetGroupExecute(r ApiGetGroupRequest) (*Group, *http.Response, error)

Execute executes the request 

@return Group

func (*GroupsApi) GetGroups 

func (a *GroupsApi) GetGroups(ctx context.Context) ApiGetGroupsRequest

GetGroups List groups

Returns a paginated groups list for the account. Only groups the user has access to are returned. The results sort order is not stable, on subsequent requests different results may be returned. This query resource is meant for administrative actions only, therefore has a lower rate limit tier than user permissions related resources. Additionally, the results from a query to Groups may be delayed up to 5 minutes. 

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

func (*GroupsApi) GetGroupsExecute 

func (a *GroupsApi) GetGroupsExecute(r ApiGetGroupsRequest) (*GroupCollection, *http.Response, error)

Execute executes the request 

@return GroupCollection

func (*GroupsApi) UpdateGroup 

func (a *GroupsApi) UpdateGroup(ctx context.Context, groupId GroupId) ApiUpdateGroupRequest

UpdateGroup Update a group

Updates a group adding or removing user. Change a group updates the permissions and roles the users have access to. (Groups have a maximum size of ~100KB) 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId The identifier of the group.
@return ApiUpdateGroupRequest

func (*GroupsApi) UpdateGroupExecute 

func (a *GroupsApi) UpdateGroupExecute(r ApiUpdateGroupRequest) (*Group, *http.Response, error)

Execute executes the request 

@return Group

type HttpClient 

type HttpClient struct {
	ClientConfiguration *Configuration
	InternalClient      *http.Client
}

type InvitesApi 

type InvitesApi struct {
	Client *HttpClient
}

InvitesApi Invites service

func (*InvitesApi) CreateInvite 

func (a *InvitesApi) CreateInvite(ctx context.Context) ApiCreateInviteRequest

CreateInvite Create user invite

Invites are used to easily assign permissions to users that have not been created in your identity provider yet.

  1. This generates an invite record.

  2. Send the invite ID to the user.

  3. Log the user in.

  4. As the user PATCH the /invite/{inviteId} endpoint

  5. This accepts the invite. When the user accepts the invite they will automatically receive the permissions assigned in the Invite. Invites automatically expire after 7 days.

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

func (*InvitesApi) CreateInviteExecute 

func (a *InvitesApi) CreateInviteExecute(r ApiCreateInviteRequest) (*Invite, *http.Response, error)

Execute executes the request 

@return Invite

func (*InvitesApi) DeleteInvite 

func (a *InvitesApi) DeleteInvite(ctx context.Context, inviteId string) ApiDeleteInviteRequest

DeleteInvite Delete invite

Deletes an invite. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param inviteId The identifier of the invite.
@return ApiDeleteInviteRequest

func (*InvitesApi) DeleteInviteExecute 

func (a *InvitesApi) DeleteInviteExecute(r ApiDeleteInviteRequest) (*http.Response, error)

Execute executes the request

func (*InvitesApi) GetInvite 

func (a *InvitesApi) GetInvite(ctx context.Context, inviteId string) ApiGetInviteRequest

GetInvite Retrieve invite

Gets the invite along with the relevant invite data. Invites enable users inviting other users to their tenant, organization, or account. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param inviteId The identifier of the invite.
@return ApiGetInviteRequest

func (*InvitesApi) GetInviteExecute 

func (a *InvitesApi) GetInviteExecute(r ApiGetInviteRequest) (*Invite, *http.Response, error)

Execute executes the request 

@return Invite

func (*InvitesApi) RespondToInvite 

func (a *InvitesApi) RespondToInvite(ctx context.Context, inviteId string) ApiRespondToInviteRequest

RespondToInvite Accept invite

Accepts an invite by claiming this invite by this user. The user access token used for this request will gain the permissions associated with the invite. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param inviteId The identifier of the invite.
@return ApiRespondToInviteRequest

func (*InvitesApi) RespondToInviteExecute 

func (a *InvitesApi) RespondToInviteExecute(r ApiRespondToInviteRequest) (*http.Response, error)

Execute executes the request

type ResourcePermissionsApi 

type ResourcePermissionsApi struct {
	Client *HttpClient
}

ResourcePermissionsApi ResourcePermissions service

func (*ResourcePermissionsApi) GetPermissionedResource 

func (a *ResourcePermissionsApi) GetPermissionedResource(ctx context.Context, resourceUri string) ApiGetPermissionedResourceRequest

GetPermissionedResource Retrieve resource configuration

Permissions can be set globally at a resource level. This will apply to all users in an account. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param resourceUri The uri path of a resource to validate, must be URL encoded, uri segments are allowed.
@return ApiGetPermissionedResourceRequest

func (*ResourcePermissionsApi) GetPermissionedResourceExecute 

func (a *ResourcePermissionsApi) GetPermissionedResourceExecute(r ApiGetPermissionedResourceRequest) (*PermissionedResource, *http.Response, error)

Execute executes the request 

@return PermissionedResource

func (*ResourcePermissionsApi) GetPermissionedResources 

func (a *ResourcePermissionsApi) GetPermissionedResources(ctx context.Context) ApiGetPermissionedResourcesRequest

GetPermissionedResources List all resource configurations

Permissions can be set globally at a resource level. This endpoint returns a list of resources with globally set resource permissions. 

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

func (*ResourcePermissionsApi) GetPermissionedResourcesExecute 

func (a *ResourcePermissionsApi) GetPermissionedResourcesExecute(r ApiGetPermissionedResourcesRequest) (*PermissionedResourceCollection, *http.Response, error)

Execute executes the request 

@return PermissionedResourceCollection

func (*ResourcePermissionsApi) GetResourceUsers 

func (a *ResourcePermissionsApi) GetResourceUsers(ctx context.Context, resourceUri string) ApiGetResourceUsersRequest

GetResourceUsers List users with resource access

Get the resource users with explicit access to the resource. This result is a list of users that have some permission to the resource. Users with access to parent resources and users with access only to a sub-resource will not be returned in this result. In the case that the resource has multiple users, the list will be paginated. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param resourceUri The uri path of a resource to validate, must be URL encoded, uri segments are allowed.
@return ApiGetResourceUsersRequest

func (*ResourcePermissionsApi) GetResourceUsersExecute 

func (a *ResourcePermissionsApi) GetResourceUsersExecute(r ApiGetResourceUsersRequest) (*ResourceUsersCollection, *http.Response, error)

Execute executes the request 

@return ResourceUsersCollection

func (*ResourcePermissionsApi) UpdatePermissionedResource 

func (a *ResourcePermissionsApi) UpdatePermissionedResource(ctx context.Context, resourceUri string) ApiUpdatePermissionedResourceRequest

UpdatePermissionedResource Update resource configuration

Updates the global permissions on a resource. This applies to all users in an account. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param resourceUri The uri path of a resource to validate, must be URL encoded, uri segments are allowed.
@return ApiUpdatePermissionedResourceRequest

func (*ResourcePermissionsApi) UpdatePermissionedResourceExecute 

func (a *ResourcePermissionsApi) UpdatePermissionedResourceExecute(r ApiUpdatePermissionedResourceRequest) (*http.Response, error)

Execute executes the request

type RolesApi 

type RolesApi struct {
	Client *HttpClient
}

RolesApi Roles service

func (*RolesApi) CreateRole 

func (a *RolesApi) CreateRole(ctx context.Context) ApiCreateRoleRequest

CreateRole Create role

Creates a role with permissions. 

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

func (*RolesApi) CreateRoleExecute 

func (a *RolesApi) CreateRoleExecute(r ApiCreateRoleRequest) (*Role, *http.Response, error)

Execute executes the request 

@return Role

func (*RolesApi) DeleteRole 

func (a *RolesApi) DeleteRole(ctx context.Context, roleId string) ApiDeleteRoleRequest

DeleteRole Deletes role

Remove a role. If a record references the role, that record will not be modified. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param roleId The identifier of the role.
@return ApiDeleteRoleRequest

func (*RolesApi) DeleteRoleExecute 

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

Execute executes the request

func (*RolesApi) GetRole 

func (a *RolesApi) GetRole(ctx context.Context, roleId string) ApiGetRoleRequest

GetRole Retrieve role

Roles contain a list of permissions that will be applied to any user or resource 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param roleId The identifier of the role.
@return ApiGetRoleRequest

func (*RolesApi) GetRoleExecute 

func (a *RolesApi) GetRoleExecute(r ApiGetRoleRequest) (*Role, *http.Response, error)

Execute executes the request 

@return Role

func (*RolesApi) GetRoles 

func (a *RolesApi) GetRoles(ctx context.Context) ApiGetRolesRequest

GetRoles List roles

Get all the account roles. Roles contain a list of permissions that will be applied to any user or resource 

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

func (*RolesApi) GetRolesExecute 

func (a *RolesApi) GetRolesExecute(r ApiGetRolesRequest) (*RoleCollection, *http.Response, error)

Execute executes the request 

@return RoleCollection

func (*RolesApi) UpdateRole 

func (a *RolesApi) UpdateRole(ctx context.Context, roleId string) ApiUpdateRoleRequest

UpdateRole Update role

Updates a role adding or removing permissions. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param roleId The identifier of the role.
@return ApiUpdateRoleRequest

func (*RolesApi) UpdateRoleExecute 

func (a *RolesApi) UpdateRoleExecute(r ApiUpdateRoleRequest) (*Role, *http.Response, error)

Execute executes the request 

@return Role

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 ServiceClientsApi 

type ServiceClientsApi struct {
	Client *HttpClient
}

ServiceClientsApi ServiceClients service

func (*ServiceClientsApi) CreateClient 

func (a *ServiceClientsApi) CreateClient(ctx context.Context) ApiCreateClientRequest

CreateClient Create service client

Creates a service client to interact with Authress or any other service on behalf of users. Each client has secret private keys used to authenticate with Authress. To use service clients created through other mechanisms, skip creating a client and create access records with the client identifier. 

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

func (*ServiceClientsApi) CreateClientExecute 

func (a *ServiceClientsApi) CreateClientExecute(r ApiCreateClientRequest) (*Client, *http.Response, error)

Execute executes the request 

@return Client

func (*ServiceClientsApi) DeleteAccessKey 

func (a *ServiceClientsApi) DeleteAccessKey(ctx context.Context, clientId string, keyId string) ApiDeleteAccessKeyRequest

DeleteAccessKey Delete service client access key

Deletes an access key for a client prevent it from being used to authenticate with Authress. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param clientId The unique identifier of the client.
@param keyId The ID of the access key to remove from the client.
@return ApiDeleteAccessKeyRequest

func (*ServiceClientsApi) DeleteAccessKeyExecute 

func (a *ServiceClientsApi) DeleteAccessKeyExecute(r ApiDeleteAccessKeyRequest) (*http.Response, error)

Execute executes the request

func (*ServiceClientsApi) DeleteClient 

func (a *ServiceClientsApi) DeleteClient(ctx context.Context, clientId string) ApiDeleteClientRequest

DeleteClient Delete service client

This deletes the service client. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param clientId The unique identifier for the client.
@return ApiDeleteClientRequest

func (*ServiceClientsApi) DeleteClientExecute 

func (a *ServiceClientsApi) DeleteClientExecute(r ApiDeleteClientRequest) (*http.Response, error)

Execute executes the request

func (*ServiceClientsApi) GetClient 

func (a *ServiceClientsApi) GetClient(ctx context.Context, clientId string) ApiGetClientRequest

GetClient Retrieve service client

Returns all information related to client except for the private access keys. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param clientId The unique identifier for the client.
@return ApiGetClientRequest

func (*ServiceClientsApi) GetClientExecute 

func (a *ServiceClientsApi) GetClientExecute(r ApiGetClientRequest) (*Client, *http.Response, error)

Execute executes the request 

@return Client

func (*ServiceClientsApi) GetClients 

func (a *ServiceClientsApi) GetClients(ctx context.Context) ApiGetClientsRequest

GetClients List service clients

Returns all clients that the user has access to in the account. 

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

func (*ServiceClientsApi) GetClientsExecute 

func (a *ServiceClientsApi) GetClientsExecute(r ApiGetClientsRequest) (*ClientCollection, *http.Response, error)

Execute executes the request 

@return ClientCollection

func (*ServiceClientsApi) RequestAccessKey 

func (a *ServiceClientsApi) RequestAccessKey(ctx context.Context, clientId string) ApiRequestAccessKeyRequest

RequestAccessKey Generate service client access key

Create a new access key for the client or upload a compliant public key, so that a service can authenticate with Authress as that client. Using the client will allow delegation of permission checking of users. Enables machine-to-machine authentication between your services and with your end users. (There is a limit of 5 Active keys per client) 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param clientId The unique identifier of the client.
@return ApiRequestAccessKeyRequest

func (*ServiceClientsApi) RequestAccessKeyExecute 

func (a *ServiceClientsApi) RequestAccessKeyExecute(r ApiRequestAccessKeyRequest) (*ClientAccessKey, *http.Response, error)

Execute executes the request 

@return ClientAccessKey

func (*ServiceClientsApi) UpdateClient 

func (a *ServiceClientsApi) UpdateClient(ctx context.Context, clientId string) ApiUpdateClientRequest

UpdateClient Update service client

Updates a client information. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param clientId The unique identifier for the client.
@return ApiUpdateClientRequest

func (*ServiceClientsApi) UpdateClientExecute 

func (a *ServiceClientsApi) UpdateClientExecute(r ApiUpdateClientRequest) (*Client, *http.Response, error)

Execute executes the request 

@return Client

type TenantsApi 

type TenantsApi struct {
	Client *HttpClient
}

TenantsApi Tenants service

func (*TenantsApi) CreateTenant 

func (a *TenantsApi) CreateTenant(ctx context.Context) ApiCreateTenantRequest

CreateTenant Create tenant

Specify tenant identity details for tenant tracking, separation, and user management. Tenant identifiers are persisted to access tokens created by Authress. 

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

func (*TenantsApi) CreateTenantExecute 

func (a *TenantsApi) CreateTenantExecute(r ApiCreateTenantRequest) (*Tenant, *http.Response, error)

Execute executes the request 

@return Tenant

func (*TenantsApi) DeleteTenant 

func (a *TenantsApi) DeleteTenant(ctx context.Context, tenantId TenantId) ApiDeleteTenantRequest

DeleteTenant Delete tenant

Delete a tenant. If a connection was created for the tenant then it is deleted as well. 

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

func (*TenantsApi) DeleteTenantExecute 

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

Execute executes the request

func (*TenantsApi) GetTenant 

func (a *TenantsApi) GetTenant(ctx context.Context, tenantId TenantId) ApiGetTenantRequest

GetTenant Retrieve tenant

Get the tenant details for an Authress tenant. 

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

func (*TenantsApi) GetTenantExecute 

func (a *TenantsApi) GetTenantExecute(r ApiGetTenantRequest) (*Tenant, *http.Response, error)

Execute executes the request 

@return Tenant

func (*TenantsApi) GetTenants 

func (a *TenantsApi) GetTenants(ctx context.Context) ApiGetTenantsRequest

GetTenants List tenants

Returns a paginated tenants list for the account. Only tenants the user has access to are returned. 

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

func (*TenantsApi) GetTenantsExecute 

func (a *TenantsApi) GetTenantsExecute(r ApiGetTenantsRequest) (*TenantCollection, *http.Response, error)

Execute executes the request 

@return TenantCollection

func (*TenantsApi) UpdateTenant 

func (a *TenantsApi) UpdateTenant(ctx context.Context, tenantId TenantId) ApiUpdateTenantRequest

UpdateTenant Update tenant

Updates the tenants information and linked tenant if it exists. 

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

func (*TenantsApi) UpdateTenantExecute 

func (a *TenantsApi) UpdateTenantExecute(r ApiUpdateTenantRequest) (*Tenant, *http.Response, error)

Execute executes the request 

@return Tenant

type UserPermissionsApi 

type UserPermissionsApi struct {
	Client *HttpClient
}

UserPermissionsApi UserPermissions service

func (*UserPermissionsApi) AuthorizeUser 

func (a *UserPermissionsApi) AuthorizeUser(ctx context.Context, userId UserId, resourceUri string, permission Action) ApiAuthorizeUserRequest

AuthorizeUser Verify user authorization

Performs the user authorization check. Does the user have the specified permission to the resource? 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId The user identifier to check and verify the permissions of.
@param resourceUri The uri path of a resource to validate, must be URL encoded, uri segments are allowed, the resource must be a full path.
@param permission Permission to check, '*' and scoped permissions can also be checked here.
@return ApiAuthorizeUserRequest

func (*UserPermissionsApi) AuthorizeUserExecute 

func (a *UserPermissionsApi) AuthorizeUserExecute(r ApiAuthorizeUserRequest) (*http.Response, error)

Execute executes the request

func (*UserPermissionsApi) GetUserPermissionsForResource 

func (a *UserPermissionsApi) GetUserPermissionsForResource(ctx context.Context, userId UserId, resourceUri string) ApiGetUserPermissionsForResourceRequest

GetUserPermissionsForResource Get user permissions for resource

Get a summary of the permissions a user has to a particular resource. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId The user identifier for the user to check permissions.
@param resourceUri The uri path of a resource to validate, must be URL encoded, uri segments are allowed.
@return ApiGetUserPermissionsForResourceRequest

func (*UserPermissionsApi) GetUserPermissionsForResourceExecute 

func (a *UserPermissionsApi) GetUserPermissionsForResourceExecute(r ApiGetUserPermissionsForResourceRequest) (*PermissionCollection, *http.Response, error)

Execute executes the request 

@return PermissionCollection

func (*UserPermissionsApi) GetUserResources 

func (a *UserPermissionsApi) GetUserResources(ctx context.Context, userId UserId) ApiGetUserResourcesRequest

GetUserResources List user resources

Get the users resources. This result is a list of resource uris that a user has an permission to. By default only the top level matching resources are returned. To get a user's list of deeply nested resources, set the `collectionConfiguration` to be `INCLUDE_NESTED`. This collection is paginated. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId The user identifier for which to list all accessible resources.
@return ApiGetUserResourcesRequest

func (*UserPermissionsApi) GetUserResourcesExecute 

func (a *UserPermissionsApi) GetUserResourcesExecute(r ApiGetUserResourcesRequest) (*UserResourcesCollection, *http.Response, error)

Execute executes the request 

@return UserResourcesCollection

func (*UserPermissionsApi) GetUserRolesForResource 

func (a *UserPermissionsApi) GetUserRolesForResource(ctx context.Context, userId UserId, resourceUri string) ApiGetUserRolesForResourceRequest

GetUserRolesForResource Get user roles for resource

Get a summary of the roles a user has to a particular resource. Users can be assigned roles from multiple access records, this may cause the same role to appear in the list more than once. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId The user to get roles for.
@param resourceUri The uri path of a resource to get roles for, must be URL encoded. Checks for explicit resource roles, roles attached to parent resources are not returned.
@return ApiGetUserRolesForResourceRequest

func (*UserPermissionsApi) GetUserRolesForResourceExecute 

func (a *UserPermissionsApi) GetUserRolesForResourceExecute(r ApiGetUserRolesForResourceRequest) (*UserRoleCollection, *http.Response, error)

Execute executes the request 

@return UserRoleCollection

type UsersApi 

type UsersApi struct {
	Client *HttpClient
}

UsersApi Users service

func (*UsersApi) DeleteUser 

func (a *UsersApi) DeleteUser(ctx context.Context, userId UserId) ApiDeleteUserRequest

DeleteUser Delete a user

Removes the user, all access the user has been granted through Authress access records, and any related user data. This action is completed asynchronously. 

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

func (*UsersApi) DeleteUserExecute 

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

Execute executes the request

func (*UsersApi) GetUser 

func (a *UsersApi) GetUser(ctx context.Context, userId UserId) ApiGetUserRequest

GetUser Retrieve a user

Get the user data associated with a user. The data returned by this endpoint is highly variable based on the source OAuth provider. Avoid depending on undocumented properties. 

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

func (*UsersApi) GetUserExecute 

func (a *UsersApi) GetUserExecute(r ApiGetUserRequest) (*UserIdentity, *http.Response, error)

Execute executes the request 

@return UserIdentity

func (*UsersApi) GetUsers 

func (a *UsersApi) GetUsers(ctx context.Context) ApiGetUsersRequest

GetUsers List users

Returns a paginated user list for the account. The data returned by this endpoint is highly variable based on the source OAuth provider. Avoid depending on undocumented properties. 

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

func (*UsersApi) GetUsersExecute 

func (a *UsersApi) GetUsersExecute(r ApiGetUsersRequest) (*UserIdentityCollection, *http.Response, error)

Execute executes the request 

@return UserIdentityCollection

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.