xbim_identity 2.0.0 → 2.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- metadata +6 -107
- data/Gemfile +0 -9
- data/README.md +0 -174
- data/Rakefile +0 -10
- data/lib/xbim_identity/api/authentication_api.rb +0 -118
- data/lib/xbim_identity/api/client_applications_api.rb +0 -315
- data/lib/xbim_identity/api/invitations_api.rb +0 -489
- data/lib/xbim_identity/api/me_api.rb +0 -148
- data/lib/xbim_identity/api/members_api.rb +0 -406
- data/lib/xbim_identity/api/registration_api.rb +0 -85
- data/lib/xbim_identity/api/tenants_api.rb +0 -709
- data/lib/xbim_identity/api/users_api.rb +0 -308
- data/lib/xbim_identity/api_client.rb +0 -390
- data/lib/xbim_identity/api_error.rb +0 -57
- data/lib/xbim_identity/configuration.rb +0 -278
- data/lib/xbim_identity/models/application_type.rb +0 -39
- data/lib/xbim_identity/models/client_app.rb +0 -351
- data/lib/xbim_identity/models/client_app_endpoint.rb +0 -239
- data/lib/xbim_identity/models/draft_invitation.rb +0 -379
- data/lib/xbim_identity/models/invitation.rb +0 -379
- data/lib/xbim_identity/models/invitation_create.rb +0 -253
- data/lib/xbim_identity/models/invitation_edit.rb +0 -239
- data/lib/xbim_identity/models/invite_status.rb +0 -41
- data/lib/xbim_identity/models/master.rb +0 -331
- data/lib/xbim_identity/models/master_base.rb +0 -243
- data/lib/xbim_identity/models/master_subscription.rb +0 -323
- data/lib/xbim_identity/models/o_data_boolean.rb +0 -230
- data/lib/xbim_identity/models/o_data_client_app_endpoint_list.rb +0 -252
- data/lib/xbim_identity/models/o_data_client_app_list.rb +0 -252
- data/lib/xbim_identity/models/o_data_invitation_list.rb +0 -252
- data/lib/xbim_identity/models/o_data_string.rb +0 -230
- data/lib/xbim_identity/models/o_data_tenant_list.rb +0 -252
- data/lib/xbim_identity/models/o_data_tenant_user_list.rb +0 -252
- data/lib/xbim_identity/models/o_data_user_list.rb +0 -252
- data/lib/xbim_identity/models/problem_details.rb +0 -259
- data/lib/xbim_identity/models/region.rb +0 -280
- data/lib/xbim_identity/models/region_info.rb +0 -256
- data/lib/xbim_identity/models/subscription.rb +0 -309
- data/lib/xbim_identity/models/team_member_create.rb +0 -229
- data/lib/xbim_identity/models/team_member_edit.rb +0 -219
- data/lib/xbim_identity/models/tenancy_type.rb +0 -38
- data/lib/xbim_identity/models/tenant.rb +0 -383
- data/lib/xbim_identity/models/tenant_create.rb +0 -267
- data/lib/xbim_identity/models/tenant_edit.rb +0 -229
- data/lib/xbim_identity/models/tenant_role.rb +0 -39
- data/lib/xbim_identity/models/tenant_user.rb +0 -299
- data/lib/xbim_identity/models/token_err_response.rb +0 -219
- data/lib/xbim_identity/models/token_response.rb +0 -259
- data/lib/xbim_identity/models/user.rb +0 -261
- data/lib/xbim_identity/models/user_create.rb +0 -247
- data/lib/xbim_identity/models/user_tenant.rb +0 -279
- data/lib/xbim_identity/version.rb +0 -15
- data/lib/xbim_identity.rb +0 -83
- data/spec/api/authentication_api_spec.rb +0 -52
- data/spec/api/client_applications_api_spec.rb +0 -101
- data/spec/api/invitations_api_spec.rb +0 -130
- data/spec/api/me_api_spec.rb +0 -61
- data/spec/api/members_api_spec.rb +0 -113
- data/spec/api/registration_api_spec.rb +0 -48
- data/spec/api/tenants_api_spec.rb +0 -176
- data/spec/api/users_api_spec.rb +0 -95
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/application_type_spec.rb +0 -28
- data/spec/models/client_app_endpoint_spec.rb +0 -46
- data/spec/models/client_app_spec.rb +0 -112
- data/spec/models/draft_invitation_spec.rb +0 -130
- data/spec/models/invitation_create_spec.rb +0 -52
- data/spec/models/invitation_edit_spec.rb +0 -46
- data/spec/models/invitation_spec.rb +0 -130
- data/spec/models/invite_status_spec.rb +0 -28
- data/spec/models/master_base_spec.rb +0 -46
- data/spec/models/master_spec.rb +0 -94
- data/spec/models/master_subscription_spec.rb +0 -94
- data/spec/models/o_data_boolean_spec.rb +0 -40
- data/spec/models/o_data_client_app_endpoint_list_spec.rb +0 -52
- data/spec/models/o_data_client_app_list_spec.rb +0 -52
- data/spec/models/o_data_invitation_list_spec.rb +0 -52
- data/spec/models/o_data_string_spec.rb +0 -40
- data/spec/models/o_data_tenant_list_spec.rb +0 -52
- data/spec/models/o_data_tenant_user_list_spec.rb +0 -52
- data/spec/models/o_data_user_list_spec.rb +0 -52
- data/spec/models/problem_details_spec.rb +0 -58
- data/spec/models/region_info_spec.rb +0 -46
- data/spec/models/region_spec.rb +0 -58
- data/spec/models/subscription_spec.rb +0 -88
- data/spec/models/team_member_create_spec.rb +0 -40
- data/spec/models/team_member_edit_spec.rb +0 -34
- data/spec/models/tenancy_type_spec.rb +0 -28
- data/spec/models/tenant_create_spec.rb +0 -58
- data/spec/models/tenant_edit_spec.rb +0 -40
- data/spec/models/tenant_role_spec.rb +0 -28
- data/spec/models/tenant_spec.rb +0 -130
- data/spec/models/tenant_user_spec.rb +0 -82
- data/spec/models/token_err_response_spec.rb +0 -34
- data/spec/models/token_response_spec.rb +0 -58
- data/spec/models/user_create_spec.rb +0 -46
- data/spec/models/user_spec.rb +0 -58
- data/spec/models/user_tenant_spec.rb +0 -70
- data/spec/spec_helper.rb +0 -111
- data/xbim_identity-1.0.0.gem +0 -0
- data/xbim_identity.gemspec +0 -38
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d575f046d03e33fa856219509cfa6d63c572cf4f0919b29cf6454022c58b747f
|
4
|
+
data.tar.gz: acc1a2dd12af35919f73b249a3c3e394c0a7be1b255208a1255d45b7f2c7336e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9a7437dcc3a5476099885e163dcee4d2fa089a60e3d0637c9f82a718cba8752368ed0c9ed97858c05ccf965dc53253d71ace3320e9a16085833312bde2fb0a4f
|
7
|
+
data.tar.gz: 5948d1ceeedfdcdb683b66b589818d371e6f4b14a0e927e464ca55eaf65e1adaa0b1a334f6793ef0584ef503884247f6020344cbaf3b78a5992eda8833a8cd2f
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: xbim_identity
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.0.
|
4
|
+
version: 2.0.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
|
-
-
|
7
|
+
- OpenAPI-Generator
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-03-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -50,117 +50,16 @@ dependencies:
|
|
50
50
|
- - ">="
|
51
51
|
- !ruby/object:Gem::Version
|
52
52
|
version: 3.6.0
|
53
|
-
description:
|
53
|
+
description: Global management and user services for xbim Flex Tenants
|
54
54
|
email:
|
55
55
|
- info@xbim.net
|
56
56
|
executables: []
|
57
57
|
extensions: []
|
58
58
|
extra_rdoc_files: []
|
59
|
-
files:
|
60
|
-
- "./Gemfile"
|
61
|
-
- "./README.md"
|
62
|
-
- "./Rakefile"
|
63
|
-
- "./lib/xbim_identity.rb"
|
64
|
-
- "./lib/xbim_identity/api/authentication_api.rb"
|
65
|
-
- "./lib/xbim_identity/api/client_applications_api.rb"
|
66
|
-
- "./lib/xbim_identity/api/invitations_api.rb"
|
67
|
-
- "./lib/xbim_identity/api/me_api.rb"
|
68
|
-
- "./lib/xbim_identity/api/members_api.rb"
|
69
|
-
- "./lib/xbim_identity/api/registration_api.rb"
|
70
|
-
- "./lib/xbim_identity/api/tenants_api.rb"
|
71
|
-
- "./lib/xbim_identity/api/users_api.rb"
|
72
|
-
- "./lib/xbim_identity/api_client.rb"
|
73
|
-
- "./lib/xbim_identity/api_error.rb"
|
74
|
-
- "./lib/xbim_identity/configuration.rb"
|
75
|
-
- "./lib/xbim_identity/models/application_type.rb"
|
76
|
-
- "./lib/xbim_identity/models/client_app.rb"
|
77
|
-
- "./lib/xbim_identity/models/client_app_endpoint.rb"
|
78
|
-
- "./lib/xbim_identity/models/draft_invitation.rb"
|
79
|
-
- "./lib/xbim_identity/models/invitation.rb"
|
80
|
-
- "./lib/xbim_identity/models/invitation_create.rb"
|
81
|
-
- "./lib/xbim_identity/models/invitation_edit.rb"
|
82
|
-
- "./lib/xbim_identity/models/invite_status.rb"
|
83
|
-
- "./lib/xbim_identity/models/master.rb"
|
84
|
-
- "./lib/xbim_identity/models/master_base.rb"
|
85
|
-
- "./lib/xbim_identity/models/master_subscription.rb"
|
86
|
-
- "./lib/xbim_identity/models/o_data_boolean.rb"
|
87
|
-
- "./lib/xbim_identity/models/o_data_client_app_endpoint_list.rb"
|
88
|
-
- "./lib/xbim_identity/models/o_data_client_app_list.rb"
|
89
|
-
- "./lib/xbim_identity/models/o_data_invitation_list.rb"
|
90
|
-
- "./lib/xbim_identity/models/o_data_string.rb"
|
91
|
-
- "./lib/xbim_identity/models/o_data_tenant_list.rb"
|
92
|
-
- "./lib/xbim_identity/models/o_data_tenant_user_list.rb"
|
93
|
-
- "./lib/xbim_identity/models/o_data_user_list.rb"
|
94
|
-
- "./lib/xbim_identity/models/problem_details.rb"
|
95
|
-
- "./lib/xbim_identity/models/region.rb"
|
96
|
-
- "./lib/xbim_identity/models/region_info.rb"
|
97
|
-
- "./lib/xbim_identity/models/subscription.rb"
|
98
|
-
- "./lib/xbim_identity/models/team_member_create.rb"
|
99
|
-
- "./lib/xbim_identity/models/team_member_edit.rb"
|
100
|
-
- "./lib/xbim_identity/models/tenancy_type.rb"
|
101
|
-
- "./lib/xbim_identity/models/tenant.rb"
|
102
|
-
- "./lib/xbim_identity/models/tenant_create.rb"
|
103
|
-
- "./lib/xbim_identity/models/tenant_edit.rb"
|
104
|
-
- "./lib/xbim_identity/models/tenant_role.rb"
|
105
|
-
- "./lib/xbim_identity/models/tenant_user.rb"
|
106
|
-
- "./lib/xbim_identity/models/token_err_response.rb"
|
107
|
-
- "./lib/xbim_identity/models/token_response.rb"
|
108
|
-
- "./lib/xbim_identity/models/user.rb"
|
109
|
-
- "./lib/xbim_identity/models/user_create.rb"
|
110
|
-
- "./lib/xbim_identity/models/user_tenant.rb"
|
111
|
-
- "./lib/xbim_identity/version.rb"
|
112
|
-
- "./spec/api/authentication_api_spec.rb"
|
113
|
-
- "./spec/api/client_applications_api_spec.rb"
|
114
|
-
- "./spec/api/invitations_api_spec.rb"
|
115
|
-
- "./spec/api/me_api_spec.rb"
|
116
|
-
- "./spec/api/members_api_spec.rb"
|
117
|
-
- "./spec/api/registration_api_spec.rb"
|
118
|
-
- "./spec/api/tenants_api_spec.rb"
|
119
|
-
- "./spec/api/users_api_spec.rb"
|
120
|
-
- "./spec/api_client_spec.rb"
|
121
|
-
- "./spec/configuration_spec.rb"
|
122
|
-
- "./spec/models/application_type_spec.rb"
|
123
|
-
- "./spec/models/client_app_endpoint_spec.rb"
|
124
|
-
- "./spec/models/client_app_spec.rb"
|
125
|
-
- "./spec/models/draft_invitation_spec.rb"
|
126
|
-
- "./spec/models/invitation_create_spec.rb"
|
127
|
-
- "./spec/models/invitation_edit_spec.rb"
|
128
|
-
- "./spec/models/invitation_spec.rb"
|
129
|
-
- "./spec/models/invite_status_spec.rb"
|
130
|
-
- "./spec/models/master_base_spec.rb"
|
131
|
-
- "./spec/models/master_spec.rb"
|
132
|
-
- "./spec/models/master_subscription_spec.rb"
|
133
|
-
- "./spec/models/o_data_boolean_spec.rb"
|
134
|
-
- "./spec/models/o_data_client_app_endpoint_list_spec.rb"
|
135
|
-
- "./spec/models/o_data_client_app_list_spec.rb"
|
136
|
-
- "./spec/models/o_data_invitation_list_spec.rb"
|
137
|
-
- "./spec/models/o_data_string_spec.rb"
|
138
|
-
- "./spec/models/o_data_tenant_list_spec.rb"
|
139
|
-
- "./spec/models/o_data_tenant_user_list_spec.rb"
|
140
|
-
- "./spec/models/o_data_user_list_spec.rb"
|
141
|
-
- "./spec/models/problem_details_spec.rb"
|
142
|
-
- "./spec/models/region_info_spec.rb"
|
143
|
-
- "./spec/models/region_spec.rb"
|
144
|
-
- "./spec/models/subscription_spec.rb"
|
145
|
-
- "./spec/models/team_member_create_spec.rb"
|
146
|
-
- "./spec/models/team_member_edit_spec.rb"
|
147
|
-
- "./spec/models/tenancy_type_spec.rb"
|
148
|
-
- "./spec/models/tenant_create_spec.rb"
|
149
|
-
- "./spec/models/tenant_edit_spec.rb"
|
150
|
-
- "./spec/models/tenant_role_spec.rb"
|
151
|
-
- "./spec/models/tenant_spec.rb"
|
152
|
-
- "./spec/models/tenant_user_spec.rb"
|
153
|
-
- "./spec/models/token_err_response_spec.rb"
|
154
|
-
- "./spec/models/token_response_spec.rb"
|
155
|
-
- "./spec/models/user_create_spec.rb"
|
156
|
-
- "./spec/models/user_spec.rb"
|
157
|
-
- "./spec/models/user_tenant_spec.rb"
|
158
|
-
- "./spec/spec_helper.rb"
|
159
|
-
- "./xbim_identity-1.0.0.gem"
|
160
|
-
- "./xbim_identity.gemspec"
|
59
|
+
files: []
|
161
60
|
homepage: https://openapi-generator.tech
|
162
61
|
licenses:
|
163
|
-
-
|
62
|
+
- Unlicense
|
164
63
|
metadata: {}
|
165
64
|
post_install_message:
|
166
65
|
rdoc_options: []
|
data/Gemfile
DELETED
data/README.md
DELETED
@@ -1,174 +0,0 @@
|
|
1
|
-
# xbim_identity
|
2
|
-
|
3
|
-
XbimIdentity - the Ruby gem for the Xbim Flex Identity API 2.0
|
4
|
-
|
5
|
-
Communication centralised around construction data
|
6
|
-
|
7
|
-
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
-
|
9
|
-
- API version: 2.0
|
10
|
-
- Package version: 1.0.0
|
11
|
-
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
|
-
For more information, please visit [https://xbim.net](https://xbim.net)
|
13
|
-
|
14
|
-
## Installation
|
15
|
-
|
16
|
-
### Build a gem
|
17
|
-
|
18
|
-
To build the Ruby code into a gem:
|
19
|
-
|
20
|
-
```shell
|
21
|
-
gem build xbim_identity.gemspec
|
22
|
-
```
|
23
|
-
|
24
|
-
Then either install the gem locally:
|
25
|
-
|
26
|
-
```shell
|
27
|
-
gem install ./xbim_identity-1.0.0.gem
|
28
|
-
```
|
29
|
-
|
30
|
-
(for development, run `gem install --dev ./xbim_identity-1.0.0.gem` to install the development dependencies)
|
31
|
-
|
32
|
-
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
|
-
|
34
|
-
Finally add this to the Gemfile:
|
35
|
-
|
36
|
-
gem 'xbim_identity', '~> 1.0.0'
|
37
|
-
|
38
|
-
### Install from Git
|
39
|
-
|
40
|
-
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
41
|
-
|
42
|
-
gem 'xbim_identity', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
43
|
-
|
44
|
-
### Include the Ruby code directly
|
45
|
-
|
46
|
-
Include the Ruby code directly using `-I` as follows:
|
47
|
-
|
48
|
-
```shell
|
49
|
-
ruby -Ilib script.rb
|
50
|
-
```
|
51
|
-
|
52
|
-
## Getting Started
|
53
|
-
|
54
|
-
Please follow the [installation](#installation) procedure and then run the following code:
|
55
|
-
|
56
|
-
```ruby
|
57
|
-
# Load the gem
|
58
|
-
require 'xbim_identity'
|
59
|
-
|
60
|
-
api_instance = XbimIdentity::AuthenticationApi.new
|
61
|
-
client_id = 'client_id_example' # String | Client ID
|
62
|
-
client_secret = 'client_secret_example' # String | Client secret (password)
|
63
|
-
grant_type = 'grant_type_example' # String | Grant type must be 'master'
|
64
|
-
scope = 'scope_example' # String | Required API scopes
|
65
|
-
opts = {
|
66
|
-
user_id: 'user_id_example', # String | Xbim Flex user ID
|
67
|
-
idp_id: 'idp_id_example' # String | External identity provider user ID
|
68
|
-
}
|
69
|
-
|
70
|
-
begin
|
71
|
-
#Post Authentication get authorization token
|
72
|
-
result = api_instance.get_authorization_token(client_id, client_secret, grant_type, scope, opts)
|
73
|
-
p result
|
74
|
-
rescue XbimIdentity::ApiError => e
|
75
|
-
puts "Exception when calling AuthenticationApi->get_authorization_token: #{e}"
|
76
|
-
end
|
77
|
-
|
78
|
-
```
|
79
|
-
|
80
|
-
## Documentation for API Endpoints
|
81
|
-
|
82
|
-
All URIs are relative to *https://apis.xbim-dev.net*
|
83
|
-
|
84
|
-
Class | Method | HTTP request | Description
|
85
|
-
------------ | ------------- | ------------- | -------------
|
86
|
-
*XbimIdentity::AuthenticationApi* | [**get_authorization_token**](docs/AuthenticationApi.md#get_authorization_token) | **POST** /id/2.0/tokens | Post Authentication get authorization token
|
87
|
-
*XbimIdentity::ClientApplicationsApi* | [**id20_client_applications_client_id_endpoints_get**](docs/ClientApplicationsApi.md#id20_client_applications_client_id_endpoints_get) | **GET** /id/2.0/ClientApplications('{clientId}')/Endpoints | Gets Endpointsfor the given client
|
88
|
-
*XbimIdentity::ClientApplicationsApi* | [**id20_client_applications_client_id_endpoints_post**](docs/ClientApplicationsApi.md#id20_client_applications_client_id_endpoints_post) | **POST** /id/2.0/ClientApplications('{clientId}')/Endpoints | Adds an Endpoints to the given client
|
89
|
-
*XbimIdentity::ClientApplicationsApi* | [**id20_client_applications_client_id_get**](docs/ClientApplicationsApi.md#id20_client_applications_client_id_get) | **GET** /id/2.0/ClientApplications('{clientId}') | Gets the specified Client Application by its client id
|
90
|
-
*XbimIdentity::ClientApplicationsApi* | [**id20_client_applications_get**](docs/ClientApplicationsApi.md#id20_client_applications_get) | **GET** /id/2.0/ClientApplications | Operations to query a set of data
|
91
|
-
*XbimIdentity::InvitationsApi* | [**id20_tenants_tenant_id_invitations_get**](docs/InvitationsApi.md#id20_tenants_tenant_id_invitations_get) | **GET** /id/2.0/Tenants({tenantId})/Invitations | Operations to query the invitations
|
92
|
-
*XbimIdentity::InvitationsApi* | [**id20_tenants_tenant_id_invitations_invitation_id_despatch_post**](docs/InvitationsApi.md#id20_tenants_tenant_id_invitations_invitation_id_despatch_post) | **POST** /id/2.0/Tenants({tenantId})/Invitations({invitationId})/Despatch | Sends or Resends an Invitation Email.
|
93
|
-
*XbimIdentity::InvitationsApi* | [**id20_tenants_tenant_id_invitations_invitation_id_get**](docs/InvitationsApi.md#id20_tenants_tenant_id_invitations_invitation_id_get) | **GET** /id/2.0/Tenants({tenantId})/Invitations({invitationId}) | Gets the specified Invitation by its key
|
94
|
-
*XbimIdentity::InvitationsApi* | [**id20_tenants_tenant_id_invitations_invitation_id_patch**](docs/InvitationsApi.md#id20_tenants_tenant_id_invitations_invitation_id_patch) | **PATCH** /id/2.0/Tenants({tenantId})/Invitations({invitationId}) | Amend an existing invitation and send an email
|
95
|
-
*XbimIdentity::InvitationsApi* | [**id20_tenants_tenant_id_invitations_invitation_id_revoke_post**](docs/InvitationsApi.md#id20_tenants_tenant_id_invitations_invitation_id_revoke_post) | **POST** /id/2.0/Tenants({tenantId})/Invitations({invitationId})/Revoke | Revokes an Invitation.
|
96
|
-
*XbimIdentity::InvitationsApi* | [**id20_tenants_tenant_id_invitations_post**](docs/InvitationsApi.md#id20_tenants_tenant_id_invitations_post) | **POST** /id/2.0/Tenants({tenantId})/Invitations | Creates a new Invitation. The Invitation will only be sent if 'DraftOnly' is false
|
97
|
-
*XbimIdentity::MeApi* | [**id20_me_get**](docs/MeApi.md#id20_me_get) | **GET** /id/2.0/Me | Gets details of the current logged in user
|
98
|
-
*XbimIdentity::MeApi* | [**id20_me_regions_get**](docs/MeApi.md#id20_me_regions_get) | **GET** /id/2.0/Me/Regions | Gets a list of regions where current user has access to any tenancy (workspace)
|
99
|
-
*XbimIdentity::MembersApi* | [**id20_tenants_tenant_id_members_get**](docs/MembersApi.md#id20_tenants_tenant_id_members_get) | **GET** /id/2.0/Tenants({tenantId})/Members | Team members
|
100
|
-
*XbimIdentity::MembersApi* | [**id20_tenants_tenant_id_members_post**](docs/MembersApi.md#id20_tenants_tenant_id_members_post) | **POST** /id/2.0/Tenants({tenantId})/Members | Creates a new Team member adding an existing user to the tenant
|
101
|
-
*XbimIdentity::MembersApi* | [**id20_tenants_tenant_id_members_user_id_delete**](docs/MembersApi.md#id20_tenants_tenant_id_members_user_id_delete) | **DELETE** /id/2.0/Tenants({tenantId})/Members({userId}) | Revokes a user from this Tenant. Requires the Administrator Tenant Role
|
102
|
-
*XbimIdentity::MembersApi* | [**id20_tenants_tenant_id_members_user_id_get**](docs/MembersApi.md#id20_tenants_tenant_id_members_user_id_get) | **GET** /id/2.0/Tenants({tenantId})/Members({userId}) | Gets the specified Tenant Member by their userId
|
103
|
-
*XbimIdentity::MembersApi* | [**id20_tenants_tenant_id_members_user_id_patch**](docs/MembersApi.md#id20_tenants_tenant_id_members_user_id_patch) | **PATCH** /id/2.0/Tenants({tenantId})/Members({userId}) | Amend an existing team member's team details
|
104
|
-
*XbimIdentity::RegistrationApi* | [**id20_registration_acceptinvitation_post**](docs/RegistrationApi.md#id20_registration_acceptinvitation_post) | **POST** /id/2.0/registration/acceptinvitation | Accepts a user's invitation to join a Tenant
|
105
|
-
*XbimIdentity::TenantsApi* | [**get_tenant_by_identifier**](docs/TenantsApi.md#get_tenant_by_identifier) | **GET** /id/2.0/Tenants/GetById(identifier='{identifier}') | Gets the specified Tenant by its unique identifier
|
106
|
-
*XbimIdentity::TenantsApi* | [**id20_tenants_demo_get**](docs/TenantsApi.md#id20_tenants_demo_get) | **GET** /id/2.0/Tenants/Demo | Registers user in the 'Demo' tenancy
|
107
|
-
*XbimIdentity::TenantsApi* | [**id20_tenants_demo_tenant_id_get**](docs/TenantsApi.md#id20_tenants_demo_tenant_id_get) | **GET** /id/2.0/Tenants/DemoTenantId | Gets publickly known demo tenant id
|
108
|
-
*XbimIdentity::TenantsApi* | [**id20_tenants_get**](docs/TenantsApi.md#id20_tenants_get) | **GET** /id/2.0/Tenants | Operations to query a set of data
|
109
|
-
*XbimIdentity::TenantsApi* | [**id20_tenants_is_identifier_available_idid_get**](docs/TenantsApi.md#id20_tenants_is_identifier_available_idid_get) | **GET** /id/2.0/Tenants/IsIdentifierAvailable(id='{id}') | Checks the availability of a Tenant identifier
|
110
|
-
*XbimIdentity::TenantsApi* | [**id20_tenants_post**](docs/TenantsApi.md#id20_tenants_post) | **POST** /id/2.0/Tenants | Creates a new Tenant for the current user
|
111
|
-
*XbimIdentity::TenantsApi* | [**id20_tenants_tenant_id_delete**](docs/TenantsApi.md#id20_tenants_tenant_id_delete) | **DELETE** /id/2.0/Tenants({tenantId}) | Delete the tenant
|
112
|
-
*XbimIdentity::TenantsApi* | [**id20_tenants_tenant_id_get**](docs/TenantsApi.md#id20_tenants_tenant_id_get) | **GET** /id/2.0/Tenants({tenantId}) | Gets the specified Tenant by its key
|
113
|
-
*XbimIdentity::TenantsApi* | [**id20_tenants_tenant_id_patch**](docs/TenantsApi.md#id20_tenants_tenant_id_patch) | **PATCH** /id/2.0/Tenants({tenantId}) | Patch tenant
|
114
|
-
*XbimIdentity::TenantsApi* | [**id20_tenants_tenant_id_subscription_get**](docs/TenantsApi.md#id20_tenants_tenant_id_subscription_get) | **GET** /id/2.0/Tenants({tenantId})/Subscription | Gets Tenant Subscription Plans
|
115
|
-
*XbimIdentity::UsersApi* | [**id20_users_get**](docs/UsersApi.md#id20_users_get) | **GET** /id/2.0/Users | Get Users
|
116
|
-
*XbimIdentity::UsersApi* | [**id20_users_get_by_external_id_external_idexternal_id_get**](docs/UsersApi.md#id20_users_get_by_external_id_external_idexternal_id_get) | **GET** /id/2.0/Users/GetByExternalId(externalId='{externalId}') | Gets the specified User by their key
|
117
|
-
*XbimIdentity::UsersApi* | [**id20_users_post**](docs/UsersApi.md#id20_users_post) | **POST** /id/2.0/Users | Post Users
|
118
|
-
*XbimIdentity::UsersApi* | [**id20_users_user_id_get**](docs/UsersApi.md#id20_users_user_id_get) | **GET** /id/2.0/Users({userId}) | Gets the specified User by their key
|
119
|
-
|
120
|
-
|
121
|
-
## Documentation for Models
|
122
|
-
|
123
|
-
- [XbimIdentity::ApplicationType](docs/ApplicationType.md)
|
124
|
-
- [XbimIdentity::ClientApp](docs/ClientApp.md)
|
125
|
-
- [XbimIdentity::ClientAppEndpoint](docs/ClientAppEndpoint.md)
|
126
|
-
- [XbimIdentity::DraftInvitation](docs/DraftInvitation.md)
|
127
|
-
- [XbimIdentity::Invitation](docs/Invitation.md)
|
128
|
-
- [XbimIdentity::InvitationCreate](docs/InvitationCreate.md)
|
129
|
-
- [XbimIdentity::InvitationEdit](docs/InvitationEdit.md)
|
130
|
-
- [XbimIdentity::InviteStatus](docs/InviteStatus.md)
|
131
|
-
- [XbimIdentity::Master](docs/Master.md)
|
132
|
-
- [XbimIdentity::MasterBase](docs/MasterBase.md)
|
133
|
-
- [XbimIdentity::MasterSubscription](docs/MasterSubscription.md)
|
134
|
-
- [XbimIdentity::ODataBoolean](docs/ODataBoolean.md)
|
135
|
-
- [XbimIdentity::ODataClientAppEndpointList](docs/ODataClientAppEndpointList.md)
|
136
|
-
- [XbimIdentity::ODataClientAppList](docs/ODataClientAppList.md)
|
137
|
-
- [XbimIdentity::ODataInvitationList](docs/ODataInvitationList.md)
|
138
|
-
- [XbimIdentity::ODataString](docs/ODataString.md)
|
139
|
-
- [XbimIdentity::ODataTenantList](docs/ODataTenantList.md)
|
140
|
-
- [XbimIdentity::ODataTenantUserList](docs/ODataTenantUserList.md)
|
141
|
-
- [XbimIdentity::ODataUserList](docs/ODataUserList.md)
|
142
|
-
- [XbimIdentity::ProblemDetails](docs/ProblemDetails.md)
|
143
|
-
- [XbimIdentity::Region](docs/Region.md)
|
144
|
-
- [XbimIdentity::RegionInfo](docs/RegionInfo.md)
|
145
|
-
- [XbimIdentity::Subscription](docs/Subscription.md)
|
146
|
-
- [XbimIdentity::TeamMemberCreate](docs/TeamMemberCreate.md)
|
147
|
-
- [XbimIdentity::TeamMemberEdit](docs/TeamMemberEdit.md)
|
148
|
-
- [XbimIdentity::TenancyType](docs/TenancyType.md)
|
149
|
-
- [XbimIdentity::Tenant](docs/Tenant.md)
|
150
|
-
- [XbimIdentity::TenantCreate](docs/TenantCreate.md)
|
151
|
-
- [XbimIdentity::TenantEdit](docs/TenantEdit.md)
|
152
|
-
- [XbimIdentity::TenantRole](docs/TenantRole.md)
|
153
|
-
- [XbimIdentity::TenantUser](docs/TenantUser.md)
|
154
|
-
- [XbimIdentity::TokenErrResponse](docs/TokenErrResponse.md)
|
155
|
-
- [XbimIdentity::TokenResponse](docs/TokenResponse.md)
|
156
|
-
- [XbimIdentity::User](docs/User.md)
|
157
|
-
- [XbimIdentity::UserCreate](docs/UserCreate.md)
|
158
|
-
- [XbimIdentity::UserTenant](docs/UserTenant.md)
|
159
|
-
|
160
|
-
|
161
|
-
## Documentation for Authorization
|
162
|
-
|
163
|
-
|
164
|
-
### oauth2
|
165
|
-
|
166
|
-
|
167
|
-
- **Type**: OAuth
|
168
|
-
- **Flow**: implicit
|
169
|
-
- **Authorization URL**: https://apis.xbim-dev.net/connect/authorize
|
170
|
-
- **Scopes**:
|
171
|
-
- api.read: Access read operations
|
172
|
-
- api.write: Access write operations
|
173
|
-
- api.admin: Access Super User operations
|
174
|
-
|
data/Rakefile
DELETED
@@ -1,118 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#Xbim Flex Identity API 2.0
|
3
|
-
|
4
|
-
#Communication centralised around construction data
|
5
|
-
|
6
|
-
The version of the OpenAPI document: 2.0
|
7
|
-
Contact: info@xbim.net
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.4.0
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'cgi'
|
14
|
-
|
15
|
-
module XbimIdentity
|
16
|
-
class AuthenticationApi
|
17
|
-
attr_accessor :api_client
|
18
|
-
|
19
|
-
def initialize(api_client = ApiClient.default)
|
20
|
-
@api_client = api_client
|
21
|
-
end
|
22
|
-
# Post Authentication get authorization token
|
23
|
-
# <span style='font-size: 17px;'>Summary:</span>Gets an access token using a non-interactive flow. Only available for clients with secrets and owning Master. When no user ID is supplied, master owner user is logged in. Client can only sign in a user created in the same Master..<br/>Return Type: <b>TokenResponse</b><br/><br/>
|
24
|
-
# @param client_id [String] Client ID
|
25
|
-
# @param client_secret [String] Client secret (password)
|
26
|
-
# @param grant_type [String] Grant type must be 'master'
|
27
|
-
# @param scope [String] Required API scopes
|
28
|
-
# @param [Hash] opts the optional parameters
|
29
|
-
# @option opts [String] :user_id Xbim Flex user ID
|
30
|
-
# @option opts [String] :idp_id External identity provider user ID
|
31
|
-
# @return [TokenResponse]
|
32
|
-
def get_authorization_token(client_id, client_secret, grant_type, scope, opts = {})
|
33
|
-
data, _status_code, _headers = get_authorization_token_with_http_info(client_id, client_secret, grant_type, scope, opts)
|
34
|
-
data
|
35
|
-
end
|
36
|
-
|
37
|
-
# Post Authentication get authorization token
|
38
|
-
# <span style='font-size: 17px;'>Summary:</span>Gets an access token using a non-interactive flow. Only available for clients with secrets and owning Master. When no user ID is supplied, master owner user is logged in. Client can only sign in a user created in the same Master..<br/>Return Type: <b>TokenResponse</b><br/><br/>
|
39
|
-
# @param client_id [String] Client ID
|
40
|
-
# @param client_secret [String] Client secret (password)
|
41
|
-
# @param grant_type [String] Grant type must be 'master'
|
42
|
-
# @param scope [String] Required API scopes
|
43
|
-
# @param [Hash] opts the optional parameters
|
44
|
-
# @option opts [String] :user_id Xbim Flex user ID
|
45
|
-
# @option opts [String] :idp_id External identity provider user ID
|
46
|
-
# @return [Array<(TokenResponse, Integer, Hash)>] TokenResponse data, response status code and response headers
|
47
|
-
def get_authorization_token_with_http_info(client_id, client_secret, grant_type, scope, opts = {})
|
48
|
-
if @api_client.config.debugging
|
49
|
-
@api_client.config.logger.debug 'Calling API: AuthenticationApi.get_authorization_token ...'
|
50
|
-
end
|
51
|
-
# verify the required parameter 'client_id' is set
|
52
|
-
if @api_client.config.client_side_validation && client_id.nil?
|
53
|
-
fail ArgumentError, "Missing the required parameter 'client_id' when calling AuthenticationApi.get_authorization_token"
|
54
|
-
end
|
55
|
-
# verify the required parameter 'client_secret' is set
|
56
|
-
if @api_client.config.client_side_validation && client_secret.nil?
|
57
|
-
fail ArgumentError, "Missing the required parameter 'client_secret' when calling AuthenticationApi.get_authorization_token"
|
58
|
-
end
|
59
|
-
# verify the required parameter 'grant_type' is set
|
60
|
-
if @api_client.config.client_side_validation && grant_type.nil?
|
61
|
-
fail ArgumentError, "Missing the required parameter 'grant_type' when calling AuthenticationApi.get_authorization_token"
|
62
|
-
end
|
63
|
-
# verify the required parameter 'scope' is set
|
64
|
-
if @api_client.config.client_side_validation && scope.nil?
|
65
|
-
fail ArgumentError, "Missing the required parameter 'scope' when calling AuthenticationApi.get_authorization_token"
|
66
|
-
end
|
67
|
-
# resource path
|
68
|
-
local_var_path = '/id/2.0/tokens'
|
69
|
-
|
70
|
-
# query parameters
|
71
|
-
query_params = opts[:query_params] || {}
|
72
|
-
|
73
|
-
# header parameters
|
74
|
-
header_params = opts[:header_params] || {}
|
75
|
-
# HTTP header 'Accept' (if needed)
|
76
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
77
|
-
# HTTP header 'Content-Type'
|
78
|
-
content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
|
79
|
-
if !content_type.nil?
|
80
|
-
header_params['Content-Type'] = content_type
|
81
|
-
end
|
82
|
-
|
83
|
-
# form parameters
|
84
|
-
form_params = opts[:form_params] || {}
|
85
|
-
form_params['client_id'] = client_id
|
86
|
-
form_params['client_secret'] = client_secret
|
87
|
-
form_params['grant_type'] = grant_type
|
88
|
-
form_params['scope'] = scope
|
89
|
-
form_params['user_id'] = opts[:'user_id'] if !opts[:'user_id'].nil?
|
90
|
-
form_params['idp_id'] = opts[:'idp_id'] if !opts[:'idp_id'].nil?
|
91
|
-
|
92
|
-
# http body (model)
|
93
|
-
post_body = opts[:debug_body]
|
94
|
-
|
95
|
-
# return_type
|
96
|
-
return_type = opts[:debug_return_type] || 'TokenResponse'
|
97
|
-
|
98
|
-
# auth_names
|
99
|
-
auth_names = opts[:debug_auth_names] || []
|
100
|
-
|
101
|
-
new_options = opts.merge(
|
102
|
-
:operation => :"AuthenticationApi.get_authorization_token",
|
103
|
-
:header_params => header_params,
|
104
|
-
:query_params => query_params,
|
105
|
-
:form_params => form_params,
|
106
|
-
:body => post_body,
|
107
|
-
:auth_names => auth_names,
|
108
|
-
:return_type => return_type
|
109
|
-
)
|
110
|
-
|
111
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
112
|
-
if @api_client.config.debugging
|
113
|
-
@api_client.config.logger.debug "API called: AuthenticationApi#get_authorization_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
114
|
-
end
|
115
|
-
return data, status_code, headers
|
116
|
-
end
|
117
|
-
end
|
118
|
-
end
|