Module: SwaggerClient

Defined in:
lib/swagger_client/version.rb,
lib/swagger_client.rb,
lib/swagger_client/api_error.rb,
lib/swagger_client/api_client.rb,
lib/swagger_client/models/body.rb,
lib/swagger_client/models/link.rb,
lib/swagger_client/models/role.rb,
lib/swagger_client/models/user.rb,
lib/swagger_client/api/roles_api.rb,
lib/swagger_client/configuration.rb,
lib/swagger_client/models/body_1.rb,
lib/swagger_client/models/body_2.rb,
lib/swagger_client/models/body_3.rb,
lib/swagger_client/models/body_4.rb,
lib/swagger_client/models/body_5.rb,
lib/swagger_client/models/body_6.rb,
lib/swagger_client/models/body_7.rb,
lib/swagger_client/models/body_8.rb,
lib/swagger_client/models/body_9.rb,
lib/swagger_client/models/client.rb,
lib/swagger_client/models/invite.rb,
lib/swagger_client/models/account.rb,
lib/swagger_client/models/body_10.rb,
lib/swagger_client/models/body_11.rb,
lib/swagger_client/models/identity.rb,
lib/swagger_client/api/accounts_api.rb,
lib/swagger_client/api/metadata_api.rb,
lib/swagger_client/models/statement.rb,
lib/swagger_client/models/user_token.rb,
lib/swagger_client/models/access_record.rb,
lib/swagger_client/models/claim_request.rb,
lib/swagger_client/models/token_request.rb,
lib/swagger_client/models/claim_response.rb,
lib/swagger_client/models/user_resources.rb,
lib/swagger_client/api/access_records_api.rb,
lib/swagger_client/models/metadata_object.rb,
lib/swagger_client/models/v1records_links.rb,
lib/swagger_client/models/v1records_users.rb,
lib/swagger_client/api/service_clients_api.rb,
lib/swagger_client/models/identity_request.rb,
lib/swagger_client/models/user_token_links.rb,
lib/swagger_client/api/user_permissions_api.rb,
lib/swagger_client/models/client_access_key.rb,
lib/swagger_client/models/client_collection.rb,
lib/swagger_client/models/permission_object.rb,
lib/swagger_client/models/v1clients_options.rb,
lib/swagger_client/models/v1records_account.rb,
lib/swagger_client/models/account_collection.rb,
lib/swagger_client/models/identity_collection.rb,
lib/swagger_client/models/inline_response_200.rb,
lib/swagger_client/models/permission_response.rb,
lib/swagger_client/models/resource_permission.rb,
lib/swagger_client/models/v1roles_permissions.rb,
lib/swagger_client/models/v1records_links_self.rb,
lib/swagger_client/api/resource_permissions_api.rb,
lib/swagger_client/models/inline_response_200_1.rb,
lib/swagger_client/models/inline_response_200_2.rb,
lib/swagger_client/models/inline_response_200_3.rb,
lib/swagger_client/models/inline_response_200_4.rb,
lib/swagger_client/models/inline_response_200_5.rb,
lib/swagger_client/models/inline_response_200_6.rb,
lib/swagger_client/models/inline_response_200_7.rb,
lib/swagger_client/models/inline_response_200_8.rb,
lib/swagger_client/models/inline_response_200_9.rb,
lib/swagger_client/models/user_token_links_self.rb,
lib/swagger_client/models/inline_response_200_10.rb,
lib/swagger_client/models/inline_response_200_11.rb,
lib/swagger_client/models/inline_response_200_12.rb,
lib/swagger_client/models/inline_response_200_13.rb,
lib/swagger_client/models/inline_response_200_14.rb,
lib/swagger_client/models/inline_response_200_15.rb,
lib/swagger_client/models/access_record_collection.rb,
lib/swagger_client/models/user_resources_resources.rb,
lib/swagger_client/models/client_collection_clients.rb,
lib/swagger_client/models/resource_users_collection.rb,
lib/swagger_client/models/account_collection_accounts.rb,
lib/swagger_client/models/identity_collection_identities.rb,
lib/swagger_client/models/resource_permission_collection.rb,
lib/swagger_client/models/v1usersuser_idtokens_resources.rb,
lib/swagger_client/models/v1usersuser_idtokens_statements.rb,
lib/swagger_client/models/access_record_collection_records.rb,
lib/swagger_client/models/v1resourcesresource_uri_permissions.rb,
lib/swagger_client/models/resource_permission_collection_links.rb,
lib/swagger_client/models/resource_permission_collection_resources.rb,
lib/swagger_client/models/resource_permission_collection_links_next.rb,
lib/swagger_client/models/v1usersuser_idresourcesresource_urimetadata_account.rb

Overview

#Authress

#<p> <h2>Authorization</h2> <p>Authorization for Authress is handled one of two different ways. Both mechanisms use oauth2 Bearer tokens.</p>
<h4>Identity Provider JWT</h4> <p>Hook up your preferred identity provider directly to Authress. Authress will verify JWTs sourced from that identify provider and allow direct integration with these APIs. Any OIDC JWT provider works, Google, Auth0, Okta, etc… With this mechanism your web app can make direct calls to the permissions API on behalf of your users.
<a href="authress.io/app/#/manage?focus=identity">Link identity provider</a> </p>
<h4>Authress Clients</h4> <p>Regardless of using direct identity provider integration, with the API you can create Authress clients which can call any of the methods on the API. Your users won’t be able to directly make API calls, all web app integrations must go through a service which stores the Authress private key.
<a href="authress.io/app/#/manage?focus=clients">Create Authress service client</a> </p>
<h2>Usage</h2> <h4>Billable APIs</h4> <p>Most of the api available is completely free. Use it to populate your roles and configure your account. You’ll only be charged for the ones marked as Billable.</p> <p><ul> <li><i class="far fa-fw fa-money-bill-alt text-primary"></i> <span class="text-primary">Billable</span> - <small>These APIs count as calls for your account and will be charged.</small></li> <li><i class="fas fa-fw fa-angle-double-right text-secondary"></i> <span class="text-secondary">Free</span> - <small>These are totally free.</small></li> <li><i class="fas fa-fw fa-balance-scale text-secondary"></i> <span class="text-secondary">Condition</span> - <small>Are conditionally free, see api methods for details.</small></li> </ul></p>
<h4>API Access</h4> <p>Access to the following APIs is based on Authress permissions, not the application permissions assigned in Authress to the application services. Each resource is tagged with the required permission <span class="badge badge-outline-secondary">Action: Resource</span> </p>

OpenAPI spec version: v1 Contact: [email protected] Generated by: github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 3.0.23

Defined Under Namespace

Classes: AccessRecord, AccessRecordCollection, AccessRecordCollectionRecords, AccessRecordsApi, Account, AccountCollection, AccountCollectionAccounts, AccountsApi, ApiClient, ApiError, Body, Body1, Body10, Body11, Body2, Body3, Body4, Body5, Body6, Body7, Body8, Body9, ClaimRequest, ClaimResponse, Client, ClientAccessKey, ClientCollection, ClientCollectionClients, Configuration, Identity, IdentityCollection, IdentityCollectionIdentities, IdentityRequest, InlineResponse200, InlineResponse2001, InlineResponse20010, InlineResponse20011, InlineResponse20012, InlineResponse20013, InlineResponse20014, InlineResponse20015, InlineResponse2002, InlineResponse2003, InlineResponse2004, InlineResponse2005, InlineResponse2006, InlineResponse2007, InlineResponse2008, InlineResponse2009, Invite, Link, MetadataApi, MetadataObject, PermissionObject, PermissionResponse, ResourcePermission, ResourcePermissionCollection, ResourcePermissionCollectionLinks, ResourcePermissionCollectionLinksNext, ResourcePermissionCollectionResources, ResourcePermissionsApi, ResourceUsersCollection, Role, RolesApi, ServiceClientsApi, Statement, TokenRequest, User, UserPermissionsApi, UserResources, UserResourcesResources, UserToken, UserTokenLinks, UserTokenLinksSelf, V1clientsOptions, V1recordsAccount, V1recordsLinks, V1recordsLinksSelf, V1recordsUsers, V1resourcesresourceUriPermissions, V1rolesPermissions, V1usersuserIdresourcesresourceUrimetadataAccount, V1usersuserIdtokensResources, V1usersuserIdtokensStatements

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

SwaggerClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



22
23
24
25
26
27
28
 
# File 'lib/swagger_client.rb', line 22

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end