antimatter_api 2.0.13

Interact with the Antimatter Cloud API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594

# \AuthenticationApi

All URIs are relative to *https://api.antimatter.io/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**domain_authenticate**](AuthenticationApi.md#domain_authenticate) | **POST** /domains/{domainID}/authenticate | Authenticate with a domain
[**domain_contact_issue_verify**](AuthenticationApi.md#domain_contact_issue_verify) | **POST** /domains/{domainID}/account/verify | Issue a new verification request
[**domain_contact_verify**](AuthenticationApi.md#domain_contact_verify) | **GET** /domains/{domainID}/account/verify | Verify an admin contact email
[**domain_delete_capability**](AuthenticationApi.md#domain_delete_capability) | **DELETE** /domains/{domainID}/control/capabilities/{capability} | Delete a capability
[**domain_delete_identity_provider**](AuthenticationApi.md#domain_delete_identity_provider) | **DELETE** /domains/{domainID}/control/identities/{identityProviderName} | Delete an identity provider
[**domain_delete_identity_provider_principal**](AuthenticationApi.md#domain_delete_identity_provider_principal) | **DELETE** /domains/{domainID}/control/identities/{identityProviderName}/principals/{principalID} | Delete identity provider principal
[**domain_get_capabilities**](AuthenticationApi.md#domain_get_capabilities) | **GET** /domains/{domainID}/control/capabilities | Get the domain capabilities
[**domain_get_capability**](AuthenticationApi.md#domain_get_capability) | **GET** /domains/{domainID}/control/capabilities/{capability} | Get a single capability
[**domain_get_identity_group_providers**](AuthenticationApi.md#domain_get_identity_group_providers) | **GET** /domains/{domainID}/control/identities/group-providers | Get supported group identity provider details
[**domain_get_identity_provider**](AuthenticationApi.md#domain_get_identity_provider) | **GET** /domains/{domainID}/control/identities/{identityProviderName} | Get an identity provider's details
[**domain_get_identity_provider_principal**](AuthenticationApi.md#domain_get_identity_provider_principal) | **GET** /domains/{domainID}/control/identities/{identityProviderName}/principals/{principalID} | Get identity provider principal details
[**domain_get_identity_provider_principals**](AuthenticationApi.md#domain_get_identity_provider_principals) | **GET** /domains/{domainID}/control/identities/{identityProviderName}/principals | Get an identity provider's principals
[**domain_insert_identity_provider_principal**](AuthenticationApi.md#domain_insert_identity_provider_principal) | **POST** /domains/{domainID}/control/identities/{identityProviderName}/principals | Create a new principal for the provider
[**domain_list_identity_providers**](AuthenticationApi.md#domain_list_identity_providers) | **GET** /domains/{domainID}/control/identities | Get a summary of the domain's Identity Providers
[**domain_put_capability**](AuthenticationApi.md#domain_put_capability) | **PUT** /domains/{domainID}/control/capabilities/{capability} | Create or update a capability
[**domain_put_vendor_settings**](AuthenticationApi.md#domain_put_vendor_settings) | **PUT** /domains/{domainID}/control/vendor/settings | Create or update vendor settings
[**domain_update_identity_provider_principal**](AuthenticationApi.md#domain_update_identity_provider_principal) | **PUT** /domains/{domainID}/control/identities/{identityProviderName}/principals/{principalID} | Update identity provider principal capabilities
[**domain_upsert_identity_provider**](AuthenticationApi.md#domain_upsert_identity_provider) | **PUT** /domains/{domainID}/control/identities/{identityProviderName} | Create/Update an identity provider



## domain_authenticate

> models::DomainAuthenticateResponse domain_authenticate(domain_id, domain_authenticate, identity_provider_name, token_exchange, token_lifetime)
Authenticate with a domain

Use an authentication method to obtain a domain ID token which is used as the bearer for all other endpoints. You can use the `/public-info` route to obtain a list of identity providers supported by this endpoint. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**domain_authenticate** | [**DomainAuthenticate**](DomainAuthenticate.md) |  | [required] |
**identity_provider_name** | Option<**String**> |  |  |
**token_exchange** | Option<**bool**> |  |  |
**token_lifetime** | Option<**i32**> | Lifetime of token in seconds. Setting this will override the domain default. This cannot be greater than the domain's maximum token lifetime. The default and maximum token lifetime values can be seen and set at the `/control/settings` route.  |  |

### Return type

[**models::DomainAuthenticateResponse**](DomainAuthenticateResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

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


## domain_contact_issue_verify

> domain_contact_issue_verify(domain_id, domain_contact_issue_verify_request)
Issue a new verification request

Issue a new verification request to a pending contact email associated with the domain. There is a rate limiter on this endpoint, you may need to wait between invocations. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**domain_contact_issue_verify_request** | [**DomainContactIssueVerifyRequest**](DomainContactIssueVerifyRequest.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

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


## domain_contact_verify

> models::VerifyContactResponse domain_contact_verify(domain_id, address, token, google_jwt)
Verify an admin contact email

Verify an admin contact email recently associated with a domain. The token will have been emailed (in the form of a link) to the email address when `/account/verify` is called, the domain was initially created, or the email was added via the settings endpoint. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**address** | **String** | Email address to be tested against the supplied token | [required] |
**token** | Option<**String**> | Security token issued with verification request |  |
**google_jwt** | Option<**String**> | Google-issued JWT carrying the verification email address  |  |

### Return type

[**models::VerifyContactResponse**](VerifyContactResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## domain_delete_capability

> domain_delete_capability(domain_id, capability)
Delete a capability

Delete a capability. All rules that reference the capability must have already been deleted, or you will get an error 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**capability** | **String** | the name for this capability, like \"admin\" | [required] |

### Return type

 (empty response body)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## domain_delete_identity_provider

> domain_delete_identity_provider(domain_id, identity_provider_name)
Delete an identity provider

Delete an identity provider. All domain tokens created using this identity provider will be invalidated. Take care not to remove the identity provider that is providing you admin access to your domain, as you may \"lock yourself out\". 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**identity_provider_name** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## domain_delete_identity_provider_principal

> domain_delete_identity_provider_principal(domain_id, identity_provider_name, principal_id)
Delete identity provider principal

Delete an identity provider principal. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**identity_provider_name** | **String** |  | [required] |
**principal_id** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## domain_get_capabilities

> models::CapabilityDefinitionList domain_get_capabilities(domain_id)
Get the domain capabilities

Get the capabilities configured within the domain. A capability is a key/value pair that can be attached to a principal by an identity provider. The capabilities can be referenced by the domain policy rules. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |

### Return type

[**models::CapabilityDefinitionList**](CapabilityDefinitionList.md)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## domain_get_capability

> models::CapabilityDefinition domain_get_capability(domain_id, capability)
Get a single capability

Get a capability. A capability is a key/value pair that can be  attached to a domain identity by an identity provider. The capabilities can be referenced by the domain policy rules. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**capability** | **String** | the name for this capability, like \"admin\" | [required] |

### Return type

[**models::CapabilityDefinition**](CapabilityDefinition.md)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## domain_get_identity_group_providers

> models::DomainIdentityGroupProviderDetails domain_get_identity_group_providers(domain_id)
Get supported group identity provider details

Retrieve details on what information is required in order to allow for mapping external domain group membership to capabilities at authentication. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |

### Return type

[**models::DomainIdentityGroupProviderDetails**](DomainIdentityGroupProviderDetails.md)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## domain_get_identity_provider

> models::DomainIdentityProviderInfo domain_get_identity_provider(domain_id, identity_provider_name)
Get an identity provider's details

Retrieve detailed information and configuration of an identity provider. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**identity_provider_name** | **String** |  | [required] |

### Return type

[**models::DomainIdentityProviderInfo**](DomainIdentityProviderInfo.md)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## domain_get_identity_provider_principal

> models::PrincipalInfo domain_get_identity_provider_principal(domain_id, identity_provider_name, principal_id)
Get identity provider principal details

Retrieve detailed information about an identity provider principal. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**identity_provider_name** | **String** |  | [required] |
**principal_id** | **String** |  | [required] |

### Return type

[**models::PrincipalInfo**](PrincipalInfo.md)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## domain_get_identity_provider_principals

> models::DomainIdentityProviderPrincipalList domain_get_identity_provider_principals(domain_id, identity_provider_name)
Get an identity provider's principals

Retrieve a list of principals for an identity provider 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**identity_provider_name** | **String** |  | [required] |

### Return type

[**models::DomainIdentityProviderPrincipalList**](DomainIdentityProviderPrincipalList.md)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## domain_insert_identity_provider_principal

> models::DomainInsertIdentityProviderPrincipal200Response domain_insert_identity_provider_principal(domain_id, identity_provider_name, domain_identity_provider_principal_params)
Create a new principal for the provider

Create a new principal for the provider. Note that the identityProviderName must refer to an existing identity provider or the response will be a 400. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**identity_provider_name** | **String** |  | [required] |
**domain_identity_provider_principal_params** | [**DomainIdentityProviderPrincipalParams**](DomainIdentityProviderPrincipalParams.md) |  | [required] |

### Return type

[**models::DomainInsertIdentityProviderPrincipal200Response**](domainInsertIdentityProviderPrincipal_200_response.md)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

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


## domain_list_identity_providers

> models::DomainIdentityProviderList domain_list_identity_providers(domain_id)
Get a summary of the domain's Identity Providers

Retrieve the domain's identity providers and a brief overview of their configuration. This endpoint requires authentication, but you can obtain an abridged list of the domain identity providers prior to authentication using the `/public-info` endpoint. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |

### Return type

[**models::DomainIdentityProviderList**](DomainIdentityProviderList.md)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## domain_put_capability

> domain_put_capability(domain_id, capability, new_capability_definition, createonly)
Create or update a capability

Create or update a capability. If you want to return an error if the capability already existed, set createonly=true 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**capability** | **String** | the name for this capability, like \"admin\" | [required] |
**new_capability_definition** | [**NewCapabilityDefinition**](NewCapabilityDefinition.md) |  | [required] |
**createonly** | Option<**bool**> | return an error if the capability already existed |  |

### Return type

 (empty response body)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

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


## domain_put_vendor_settings

> domain_put_vendor_settings(domain_id, new_vendor_settings)
Create or update vendor settings

Create or update the vendor settings for a given domain. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**new_vendor_settings** | [**NewVendorSettings**](NewVendorSettings.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

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


## domain_update_identity_provider_principal

> domain_update_identity_provider_principal(domain_id, identity_provider_name, principal_id, update_principal_params)
Update identity provider principal capabilities

Update the set of capabilities assigned to an identity provider principal. The capabilities must exist. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**identity_provider_name** | **String** |  | [required] |
**principal_id** | **String** |  | [required] |
**update_principal_params** | [**UpdatePrincipalParams**](UpdatePrincipalParams.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

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


## domain_upsert_identity_provider

> models::DomainIdentityProviderInfo domain_upsert_identity_provider(domain_id, identity_provider_name, domain_identity_provider_details)
Create/Update an identity provider

Create or configure an identity provider. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**identity_provider_name** | **String** |  | [required] |
**domain_identity_provider_details** | [**DomainIdentityProviderDetails**](DomainIdentityProviderDetails.md) |  | [required] |

### Return type

[**models::DomainIdentityProviderInfo**](DomainIdentityProviderInfo.md)

### Authorization

[domain_identity](../README.md#domain_identity)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

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