Skip to content

Commit d0966e9

Browse files
xgpxgp
authored
Merge pull request #7 from p2-inc/update-openapi
update to current openapi spec
2 parents cd5f9fe + b685c70 commit d0966e9

File tree

100 files changed

+7690
-60
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

100 files changed

+7690
-60
lines changed

‎docs/apis/tags/IdentityProvidersApi.md‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Method | HTTP request | Description
1414
[**get_idp_mappers**](#get_idp_mappers) | **get** /{realm}/orgs/{orgId}/idps/{alias}/mappers | Get mappers for identity provider
1515
[**get_idps**](#get_idps) | **get** /{realm}/orgs/{orgId}/idps | Get identity providers for this organization
1616
[**import_idp_json**](#import_idp_json) | **post** /{realm}/orgs/{orgId}/idps/import-config | Import identity provider from uploaded JSON file
17+
[**link_idp**](#link_idp) | **post** /{realm}/orgs/{orgId}/idps/link | Link an existing identity provider to this organization
1718
[**update_idp**](#update_idp) | **put** /{realm}/orgs/{orgId}/idps/{alias} | Update identity provider for this organization by alias
1819
[**update_idp_mapper**](#update_idp_mapper) | **put** /{realm}/orgs/{orgId}/idps/{alias}/mappers/{id} | Update a mapper for the identity provider
1920

@@ -1069,6 +1070,120 @@ Key | Input Type | Accessed Type | Description | Notes
10691070

10701071
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
10711072

1073+
# **link_idp**
1074+
<a name="link_idp"></a>
1075+
> link_idp(realmorg_idlink_identity_provider_representation)
1076+
1077+
Link an existing identity provider to this organization
1078+
1079+
### Example
1080+
1081+
* Bearer Authentication (access_token):
1082+
```python
1083+
import phasetwo
1084+
from phasetwo.apis.tags import identity_providers_api
1085+
from phasetwo.model.link_identity_provider_representation import LinkIdentityProviderRepresentation
1086+
from pprint import pprint
1087+
# Defining the host is optional and defaults to https://app.phasetwo.io/realms
1088+
# See configuration.py for a list of all supported configuration parameters.
1089+
configuration = phasetwo.Configuration(
1090+
host = "https://app.phasetwo.io/realms"
1091+
)
1092+
1093+
# The client must configure the authentication and authorization parameters
1094+
# in accordance with the API server security policy.
1095+
# Examples for each auth method are provided below, use the example that
1096+
# satisfies your auth use case.
1097+
1098+
# Configure Bearer authorization: access_token
1099+
configuration = phasetwo.Configuration(
1100+
access_token = 'YOUR_BEARER_TOKEN'
1101+
)
1102+
# Enter a context with an instance of the API client
1103+
with phasetwo.ApiClient(configuration) as api_client:
1104+
# Create an instance of the API class
1105+
api_instance = identity_providers_api.IdentityProvidersApi(api_client)
1106+
1107+
# example passing only required values which don't have defaults set
1108+
path_params = {
1109+
'realm': "realm_example",
1110+
'orgId': "orgId_example",
1111+
}
1112+
body = LinkIdentityProviderRepresentation(
1113+
alias="alias_example",
1114+
post_broker_flow="post_broker_flow_example",
1115+
sync_mode="sync_mode_example",
1116+
)
1117+
try:
1118+
# Link an existing identity provider to this organization
1119+
api_response = api_instance.link_idp(
1120+
path_params=path_params,
1121+
body=body,
1122+
)
1123+
except phasetwo.ApiException as e:
1124+
print("Exception when calling IdentityProvidersApi->link_idp: %s\n" % e)
1125+
```
1126+
### Parameters
1127+
1128+
Name | Type | Description | Notes
1129+
------------- | ------------- | ------------- | -------------
1130+
body | typing.Union[SchemaForRequestBodyApplicationJson] | required |
1131+
path_params | RequestPathParams | |
1132+
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
1133+
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
1134+
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
1135+
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
1136+
1137+
### body
1138+
1139+
# SchemaForRequestBodyApplicationJson
1140+
Type | Description | Notes
1141+
------------- | ------------- | -------------
1142+
[**LinkIdentityProviderRepresentation**](../../models/LinkIdentityProviderRepresentation.md) | |
1143+
1144+
1145+
### path_params
1146+
#### RequestPathParams
1147+
1148+
Name | Type | Description | Notes
1149+
------------- | ------------- | ------------- | -------------
1150+
realm | RealmSchema | |
1151+
orgId | OrgIdSchema | |
1152+
1153+
# RealmSchema
1154+
1155+
## Model Type Info
1156+
Input Type | Accessed Type | Description | Notes
1157+
------------ | ------------- | ------------- | -------------
1158+
str, | str, | |
1159+
1160+
# OrgIdSchema
1161+
1162+
## Model Type Info
1163+
Input Type | Accessed Type | Description | Notes
1164+
------------ | ------------- | ------------- | -------------
1165+
str, | str, | |
1166+
1167+
### Return Types, Responses
1168+
1169+
Code | Class | Description
1170+
------------- | ------------- | -------------
1171+
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
1172+
201 | [ApiResponseFor201](#link_idp.ApiResponseFor201) | success
1173+
1174+
#### link_idp.ApiResponseFor201
1175+
Name | Type | Description | Notes
1176+
------------- | ------------- | ------------- | -------------
1177+
response | urllib3.HTTPResponse | Raw response |
1178+
body | Unset | body was not defined |
1179+
headers | Unset | headers were not defined |
1180+
1181+
### Authorization
1182+
1183+
[access_token](../../../README.md#access_token)
1184+
1185+
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
1186+
10721187
# **update_idp**
10731188
<a name="update_idp"></a>
10741189
> update_idp(realmorg_idaliasidentity_provider_representation)

‎docs/apis/tags/OrganizationInvitationApi.md‎

Lines changed: 235 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,235 @@
1+
<a name="__pageTop"></a>
2+
# phasetwo.apis.tags.organization_invitation_api.OrganizationInvitationApi
3+
4+
All URIs are relative to *https://app.phasetwo.io/realms*
5+
6+
Method | HTTP request | Description
7+
------------- | ------------- | -------------
8+
[**get_organization_invitation_by_id**](#get_organization_invitation_by_id) | **get** /{realm}/orgs/{orgId}/invitations/{invitationId} | Get organization invitation by ID
9+
[**resend_organization_invitation**](#resend_organization_invitation) | **put** /{realm}/orgs/{orgId}/invitations/{invitationId}/resend-email | Resend an Organization Invitation
10+
11+
# **get_organization_invitation_by_id**
12+
<a name="get_organization_invitation_by_id"></a>
13+
> InvitationRepresentation get_organization_invitation_by_id(realmorg_idinvitation_id)
14+
15+
Get organization invitation by ID
16+
17+
Get an invitation to an organization by its uuid.
18+
19+
### Example
20+
21+
* Bearer Authentication (access_token):
22+
```python
23+
import phasetwo
24+
from phasetwo.apis.tags import organization_invitation_api
25+
from phasetwo.model.invitation_representation import InvitationRepresentation
26+
from pprint import pprint
27+
# Defining the host is optional and defaults to https://app.phasetwo.io/realms
28+
# See configuration.py for a list of all supported configuration parameters.
29+
configuration = phasetwo.Configuration(
30+
host = "https://app.phasetwo.io/realms"
31+
)
32+
33+
# The client must configure the authentication and authorization parameters
34+
# in accordance with the API server security policy.
35+
# Examples for each auth method are provided below, use the example that
36+
# satisfies your auth use case.
37+
38+
# Configure Bearer authorization: access_token
39+
configuration = phasetwo.Configuration(
40+
access_token = 'YOUR_BEARER_TOKEN'
41+
)
42+
# Enter a context with an instance of the API client
43+
with phasetwo.ApiClient(configuration) as api_client:
44+
# Create an instance of the API class
45+
api_instance = organization_invitation_api.OrganizationInvitationApi(api_client)
46+
47+
# example passing only required values which don't have defaults set
48+
path_params = {
49+
'realm': "realm_example",
50+
'orgId': "orgId_example",
51+
'invitationId': "invitationId_example",
52+
}
53+
try:
54+
# Get organization invitation by ID
55+
api_response = api_instance.get_organization_invitation_by_id(
56+
path_params=path_params,
57+
)
58+
pprint(api_response)
59+
except phasetwo.ApiException as e:
60+
print("Exception when calling OrganizationInvitationApi->get_organization_invitation_by_id: %s\n" % e)
61+
```
62+
### Parameters
63+
64+
Name | Type | Description | Notes
65+
------------- | ------------- | ------------- | -------------
66+
path_params | RequestPathParams | |
67+
accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client
68+
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
69+
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
70+
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
71+
72+
### path_params
73+
#### RequestPathParams
74+
75+
Name | Type | Description | Notes
76+
------------- | ------------- | ------------- | -------------
77+
realm | RealmSchema | |
78+
orgId | OrgIdSchema | |
79+
invitationId | InvitationIdSchema | |
80+
81+
# RealmSchema
82+
83+
## Model Type Info
84+
Input Type | Accessed Type | Description | Notes
85+
------------ | ------------- | ------------- | -------------
86+
str, | str, | |
87+
88+
# OrgIdSchema
89+
90+
## Model Type Info
91+
Input Type | Accessed Type | Description | Notes
92+
------------ | ------------- | ------------- | -------------
93+
str, | str, | |
94+
95+
# InvitationIdSchema
96+
97+
## Model Type Info
98+
Input Type | Accessed Type | Description | Notes
99+
------------ | ------------- | ------------- | -------------
100+
str, | str, | |
101+
102+
### Return Types, Responses
103+
104+
Code | Class | Description
105+
------------- | ------------- | -------------
106+
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
107+
200 | [ApiResponseFor200](#get_organization_invitation_by_id.ApiResponseFor200) | success
108+
109+
#### get_organization_invitation_by_id.ApiResponseFor200
110+
Name | Type | Description | Notes
111+
------------- | ------------- | ------------- | -------------
112+
response | urllib3.HTTPResponse | Raw response |
113+
body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | |
114+
headers | Unset | headers were not defined |
115+
116+
# SchemaFor200ResponseBodyApplicationJson
117+
Type | Description | Notes
118+
------------- | ------------- | -------------
119+
[**InvitationRepresentation**](../../models/InvitationRepresentation.md) | |
120+
121+
122+
### Authorization
123+
124+
[access_token](../../../README.md#access_token)
125+
126+
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
127+
128+
# **resend_organization_invitation**
129+
<a name="resend_organization_invitation"></a>
130+
> resend_organization_invitation(realmorg_idinvitation_id)
131+
132+
Resend an Organization Invitation
133+
134+
Resend the email for an existing Organization Invitation
135+
136+
### Example
137+
138+
* Bearer Authentication (access_token):
139+
```python
140+
import phasetwo
141+
from phasetwo.apis.tags import organization_invitation_api
142+
from pprint import pprint
143+
# Defining the host is optional and defaults to https://app.phasetwo.io/realms
144+
# See configuration.py for a list of all supported configuration parameters.
145+
configuration = phasetwo.Configuration(
146+
host = "https://app.phasetwo.io/realms"
147+
)
148+
149+
# The client must configure the authentication and authorization parameters
150+
# in accordance with the API server security policy.
151+
# Examples for each auth method are provided below, use the example that
152+
# satisfies your auth use case.
153+
154+
# Configure Bearer authorization: access_token
155+
configuration = phasetwo.Configuration(
156+
access_token = 'YOUR_BEARER_TOKEN'
157+
)
158+
# Enter a context with an instance of the API client
159+
with phasetwo.ApiClient(configuration) as api_client:
160+
# Create an instance of the API class
161+
api_instance = organization_invitation_api.OrganizationInvitationApi(api_client)
162+
163+
# example passing only required values which don't have defaults set
164+
path_params = {
165+
'realm': "realm_example",
166+
'orgId': "orgId_example",
167+
'invitationId': "invitationId_example",
168+
}
169+
try:
170+
# Resend an Organization Invitation
171+
api_response = api_instance.resend_organization_invitation(
172+
path_params=path_params,
173+
)
174+
except phasetwo.ApiException as e:
175+
print("Exception when calling OrganizationInvitationApi->resend_organization_invitation: %s\n" % e)
176+
```
177+
### Parameters
178+
179+
Name | Type | Description | Notes
180+
------------- | ------------- | ------------- | -------------
181+
path_params | RequestPathParams | |
182+
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
183+
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
184+
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
185+
186+
### path_params
187+
#### RequestPathParams
188+
189+
Name | Type | Description | Notes
190+
------------- | ------------- | ------------- | -------------
191+
realm | RealmSchema | |
192+
orgId | OrgIdSchema | |
193+
invitationId | InvitationIdSchema | |
194+
195+
# RealmSchema
196+
197+
## Model Type Info
198+
Input Type | Accessed Type | Description | Notes
199+
------------ | ------------- | ------------- | -------------
200+
str, | str, | |
201+
202+
# OrgIdSchema
203+
204+
## Model Type Info
205+
Input Type | Accessed Type | Description | Notes
206+
------------ | ------------- | ------------- | -------------
207+
str, | str, | |
208+
209+
# InvitationIdSchema
210+
211+
## Model Type Info
212+
Input Type | Accessed Type | Description | Notes
213+
------------ | ------------- | ------------- | -------------
214+
str, | str, | |
215+
216+
### Return Types, Responses
217+
218+
Code | Class | Description
219+
------------- | ------------- | -------------
220+
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
221+
204 | [ApiResponseFor204](#resend_organization_invitation.ApiResponseFor204) | success
222+
223+
#### resend_organization_invitation.ApiResponseFor204
224+
Name | Type | Description | Notes
225+
------------- | ------------- | ------------- | -------------
226+
response | urllib3.HTTPResponse | Raw response |
227+
body | Unset | body was not defined |
228+
headers | Unset | headers were not defined |
229+
230+
### Authorization
231+
232+
[access_token](../../../README.md#access_token)
233+
234+
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
235+

‎docs/apis/tags/OrganizationInvitationsApi.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ with phasetwo.ApiClient(configuration) as api_client:
5656
roles=[
5757
"roles_example"
5858
],
59+
attributes=dict(
60+
,
61+
),
5962
)
6063
try:
6164
# Create an invitation to an organization

0 commit comments

Comments
 (0)