@scaleway/sdk-iam 1.6.0 → 2.2.0
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.
- package/README.md +96 -0
- package/dist/v1alpha1/api.gen.d.ts +46 -2
- package/dist/v1alpha1/api.gen.js +83 -2
- package/dist/v1alpha1/index.gen.d.ts +1 -1
- package/dist/v1alpha1/index.gen.js +4 -1
- package/dist/v1alpha1/marshalling.gen.d.ts +4 -1
- package/dist/v1alpha1/marshalling.gen.js +49 -0
- package/dist/v1alpha1/types.gen.d.ts +82 -0
- package/dist/v1alpha1/validation-rules.gen.d.ts +10 -0
- package/dist/v1alpha1/validation-rules.gen.js +13 -2
- package/package.json +6 -9
- package/dist/index.gen.cjs +0 -4
- package/dist/v1alpha1/api.gen.cjs +0 -1185
- package/dist/v1alpha1/index.gen.cjs +0 -69
- package/dist/v1alpha1/marshalling.gen.cjs +0 -817
- package/dist/v1alpha1/validation-rules.gen.cjs +0 -327
package/README.md
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# @scaleway/sdk-iam
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@scaleway/sdk-iam)
|
|
4
|
+
[](https://www.npmjs.com/package/@scaleway/sdk-iam)
|
|
5
|
+
[](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
|
|
6
|
+
|
|
7
|
+
Scaleway SDK for Iam API.
|
|
8
|
+
|
|
9
|
+
> **Note**
|
|
10
|
+
> This is an automatically generated package that is part of the [Scaleway SDK for JavaScript](https://github.com/scaleway/scaleway-sdk-js).
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm install @scaleway/sdk-iam @scaleway/sdk-client
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
or with pnpm:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
pnpm add @scaleway/sdk-iam @scaleway/sdk-client
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
or with yarn:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
yarn add @scaleway/sdk-iam @scaleway/sdk-client
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Getting Started
|
|
31
|
+
|
|
32
|
+
You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) on how to retrieve them.
|
|
33
|
+
|
|
34
|
+
### Basic Usage
|
|
35
|
+
|
|
36
|
+
```typescript
|
|
37
|
+
import { createClient } from '@scaleway/sdk-client'
|
|
38
|
+
import { Iam } from '@scaleway/sdk-iam'
|
|
39
|
+
|
|
40
|
+
const client = createClient({
|
|
41
|
+
accessKey: 'SCWXXXXXXXXXXXXXXXXX',
|
|
42
|
+
secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
|
|
43
|
+
defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
|
|
44
|
+
defaultRegion: 'fr-par',
|
|
45
|
+
defaultZone: 'fr-par-1',
|
|
46
|
+
})
|
|
47
|
+
|
|
48
|
+
const api = new Iam.v1.API(client)
|
|
49
|
+
|
|
50
|
+
// Use the API
|
|
51
|
+
// Example: await api.listServers()
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Using Configuration Loader
|
|
55
|
+
|
|
56
|
+
For a simpler setup, you can load credentials from the configuration file or environment variables:
|
|
57
|
+
|
|
58
|
+
```typescript
|
|
59
|
+
import { createClient } from '@scaleway/sdk-client'
|
|
60
|
+
import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
|
|
61
|
+
import { Iam } from '@scaleway/sdk-iam'
|
|
62
|
+
|
|
63
|
+
const profile = loadProfileFromConfigurationFile()
|
|
64
|
+
const client = createClient(profile)
|
|
65
|
+
const api = new Iam.v1.API(client)
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Documentation
|
|
69
|
+
|
|
70
|
+
- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
|
|
71
|
+
- 🌐 [Scaleway Iam API Documentation](https://www.scaleway.com/en/developers/api/iam/)
|
|
72
|
+
- 📖 [Main Repository](https://github.com/scaleway/scaleway-sdk-js)
|
|
73
|
+
- 💡 [Example Projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
|
|
74
|
+
|
|
75
|
+
## Features
|
|
76
|
+
|
|
77
|
+
- ✅ Full TypeScript support with complete type definitions
|
|
78
|
+
- ✅ Promise-based API
|
|
79
|
+
- ✅ Automatic pagination helpers
|
|
80
|
+
- ✅ Built-in error handling
|
|
81
|
+
- ✅ Compatible with Node.js ≥ 20
|
|
82
|
+
|
|
83
|
+
## Support
|
|
84
|
+
|
|
85
|
+
We love feedback! Feel free to reach us on:
|
|
86
|
+
- [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
|
|
87
|
+
- [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
|
|
88
|
+
|
|
89
|
+
## Contributing
|
|
90
|
+
|
|
91
|
+
This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read [CONTRIBUTING.md](https://github.com/scaleway/scaleway-sdk-js/blob/master/CONTRIBUTING.md).
|
|
92
|
+
|
|
93
|
+
## License
|
|
94
|
+
|
|
95
|
+
This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.
|
|
96
|
+
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { API as ParentAPI } from '@scaleway/sdk-client';
|
|
2
|
-
import type {
|
|
2
|
+
import type { AddGroupMemberRequest, AddGroupMembersRequest, AddSamlCertificateRequest, APIKey, Application, ClonePolicyRequest, CreateAPIKeyRequest, CreateApplicationRequest, CreateGroupRequest, CreateJWTRequest, CreatePolicyRequest, CreateScimTokenRequest, CreateScimTokenResponse, CreateSSHKeyRequest, CreateUserMFAOTPRequest, CreateUserRequest, DeleteAPIKeyRequest, DeleteApplicationRequest, DeleteGroupRequest, DeleteJWTRequest, DeletePolicyRequest, DeleteSamlCertificateRequest, DeleteSamlRequest, DeleteScimRequest, DeleteScimTokenRequest, DeleteSSHKeyRequest, DeleteUserMFAOTPRequest, DeleteUserRequest, EnableOrganizationSamlRequest, EnableOrganizationScimRequest, EncodedJWT, GetAPIKeyRequest, GetApplicationRequest, GetGroupRequest, GetJWTRequest, GetLogRequest, GetOrganizationRequest, GetOrganizationSamlRequest, GetOrganizationScimRequest, GetOrganizationSecuritySettingsRequest, GetPolicyRequest, GetQuotumRequest, GetSSHKeyRequest, GetUserConnectionsRequest, GetUserConnectionsResponse, GetUserRequest, Group, InitiateUserConnectionRequest, InitiateUserConnectionResponse, JoinUserConnectionRequest, JWT, ListAPIKeysRequest, ListAPIKeysResponse, ListApplicationsRequest, ListApplicationsResponse, ListGracePeriodsRequest, ListGracePeriodsResponse, ListGroupsRequest, ListGroupsResponse, ListJWTsRequest, ListJWTsResponse, ListLogsRequest, ListLogsResponse, ListPermissionSetsRequest, ListPermissionSetsResponse, ListPoliciesRequest, ListPoliciesResponse, ListQuotaRequest, ListQuotaResponse, ListRulesRequest, ListRulesResponse, ListSamlCertificatesRequest, ListSamlCertificatesResponse, ListScimTokensRequest, ListScimTokensResponse, ListSSHKeysRequest, ListSSHKeysResponse, ListUsersRequest, ListUsersResponse, LockUserRequest, Log, MFAOTP, Organization, OrganizationSecuritySettings, ParseSamlMetadataRequest, ParseSamlMetadataResponse, Policy, Quotum, RemoveGroupMemberRequest, RemoveUserConnectionRequest, Saml, SamlCertificate, Scim, SetGroupMembersRequest, SetOrganizationAliasRequest, SetRulesRequest, SetRulesResponse, SSHKey, UnlockUserRequest, UpdateAPIKeyRequest, UpdateApplicationRequest, UpdateGroupRequest, UpdateOrganizationLoginMethodsRequest, UpdateOrganizationSecuritySettingsRequest, UpdatePolicyRequest, UpdateSamlRequest, UpdateSSHKeyRequest, UpdateUserPasswordRequest, UpdateUserRequest, UpdateUserUsernameRequest, User, ValidateUserMFAOTPRequest, ValidateUserMFAOTPResponse } from './types.gen.js';
|
|
3
3
|
/**
|
|
4
4
|
* IAM API.
|
|
5
5
|
|
|
@@ -264,7 +264,7 @@ export declare class API extends ParentAPI {
|
|
|
264
264
|
*/
|
|
265
265
|
createPolicy: (request: Readonly<CreatePolicyRequest>) => Promise<Policy>;
|
|
266
266
|
/**
|
|
267
|
-
* Get an existing policy. Retrieve information about a policy,
|
|
267
|
+
* Get an existing policy. Retrieve information about a policy, specified by the `policy_id` parameter. The policy's full details, including `id`, `name`, `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets` are returned in the response.
|
|
268
268
|
*
|
|
269
269
|
* @param request - The request {@link GetPolicyRequest}
|
|
270
270
|
* @returns A Promise of Policy
|
|
@@ -513,4 +513,48 @@ export declare class API extends ParentAPI {
|
|
|
513
513
|
* @param request - The request {@link DeleteSamlCertificateRequest}
|
|
514
514
|
*/
|
|
515
515
|
deleteSamlCertificate: (request: Readonly<DeleteSamlCertificateRequest>) => Promise<void>;
|
|
516
|
+
/**
|
|
517
|
+
* Get SCIM configuration of an Organization.
|
|
518
|
+
*
|
|
519
|
+
* @param request - The request {@link GetOrganizationScimRequest}
|
|
520
|
+
* @returns A Promise of Scim
|
|
521
|
+
*/
|
|
522
|
+
getOrganizationScim: (request?: Readonly<GetOrganizationScimRequest>) => Promise<Scim>;
|
|
523
|
+
/**
|
|
524
|
+
* Enable SCIM for an Organization.
|
|
525
|
+
*
|
|
526
|
+
* @param request - The request {@link EnableOrganizationScimRequest}
|
|
527
|
+
* @returns A Promise of Scim
|
|
528
|
+
*/
|
|
529
|
+
enableOrganizationScim: (request?: Readonly<EnableOrganizationScimRequest>) => Promise<Scim>;
|
|
530
|
+
/**
|
|
531
|
+
* Disable SCIM for an Organization.
|
|
532
|
+
*
|
|
533
|
+
* @param request - The request {@link DeleteScimRequest}
|
|
534
|
+
*/
|
|
535
|
+
deleteScim: (request: Readonly<DeleteScimRequest>) => Promise<void>;
|
|
536
|
+
protected pageOfListScimTokens: (request: Readonly<ListScimTokensRequest>) => Promise<ListScimTokensResponse>;
|
|
537
|
+
/**
|
|
538
|
+
* List SCIM tokens.
|
|
539
|
+
*
|
|
540
|
+
* @param request - The request {@link ListScimTokensRequest}
|
|
541
|
+
* @returns A Promise of ListScimTokensResponse
|
|
542
|
+
*/
|
|
543
|
+
listScimTokens: (request: Readonly<ListScimTokensRequest>) => Promise<ListScimTokensResponse> & {
|
|
544
|
+
all: () => Promise<import("./types.gen.js").ScimToken[]>;
|
|
545
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen.js").ScimToken[], void, void>;
|
|
546
|
+
};
|
|
547
|
+
/**
|
|
548
|
+
* Create a SCIM token.
|
|
549
|
+
*
|
|
550
|
+
* @param request - The request {@link CreateScimTokenRequest}
|
|
551
|
+
* @returns A Promise of CreateScimTokenResponse
|
|
552
|
+
*/
|
|
553
|
+
createScimToken: (request: Readonly<CreateScimTokenRequest>) => Promise<CreateScimTokenResponse>;
|
|
554
|
+
/**
|
|
555
|
+
* Delete a SCIM token.
|
|
556
|
+
*
|
|
557
|
+
* @param request - The request {@link DeleteScimTokenRequest}
|
|
558
|
+
*/
|
|
559
|
+
deleteScimToken: (request: Readonly<DeleteScimTokenRequest>) => Promise<void>;
|
|
516
560
|
}
|
package/dist/v1alpha1/api.gen.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { API as API$1, urlParams, enrichForPagination, validatePathParam, resolveOneOf } from "@scaleway/sdk-client";
|
|
2
|
-
import { unmarshalListSSHKeysResponse, marshalCreateSSHKeyRequest, unmarshalSSHKey, marshalUpdateSSHKeyRequest, unmarshalListUsersResponse, unmarshalUser, marshalUpdateUserRequest, marshalCreateUserRequest, marshalUpdateUserUsernameRequest, marshalUpdateUserPasswordRequest, unmarshalMFAOTP, marshalValidateUserMFAOTPRequest, unmarshalValidateUserMFAOTPResponse, unmarshalListGracePeriodsResponse, unmarshalGetUserConnectionsResponse, unmarshalInitiateUserConnectionResponse, marshalJoinUserConnectionRequest, marshalRemoveUserConnectionRequest, unmarshalListApplicationsResponse, marshalCreateApplicationRequest, unmarshalApplication, marshalUpdateApplicationRequest, unmarshalListGroupsResponse, marshalCreateGroupRequest, unmarshalGroup, marshalUpdateGroupRequest, marshalSetGroupMembersRequest, marshalAddGroupMemberRequest, marshalAddGroupMembersRequest, marshalRemoveGroupMemberRequest, unmarshalListPoliciesResponse, marshalCreatePolicyRequest, unmarshalPolicy, marshalUpdatePolicyRequest, marshalSetRulesRequest, unmarshalSetRulesResponse, unmarshalListRulesResponse, unmarshalListPermissionSetsResponse, unmarshalListAPIKeysResponse, marshalCreateAPIKeyRequest, unmarshalAPIKey, marshalUpdateAPIKeyRequest, unmarshalListQuotaResponse, unmarshalQuotum, unmarshalListJWTsResponse, marshalCreateJWTRequest, unmarshalEncodedJWT, unmarshalJWT, unmarshalListLogsResponse, unmarshalLog, unmarshalOrganizationSecuritySettings, marshalUpdateOrganizationSecuritySettingsRequest, marshalSetOrganizationAliasRequest, unmarshalOrganization, marshalUpdateOrganizationLoginMethodsRequest, unmarshalSaml, marshalUpdateSamlRequest, marshalParseSamlMetadataRequest, unmarshalParseSamlMetadataResponse, unmarshalListSamlCertificatesResponse, marshalAddSamlCertificateRequest, unmarshalSamlCertificate } from "./marshalling.gen.js";
|
|
2
|
+
import { unmarshalListSSHKeysResponse, marshalCreateSSHKeyRequest, unmarshalSSHKey, marshalUpdateSSHKeyRequest, unmarshalListUsersResponse, unmarshalUser, marshalUpdateUserRequest, marshalCreateUserRequest, marshalUpdateUserUsernameRequest, marshalUpdateUserPasswordRequest, unmarshalMFAOTP, marshalValidateUserMFAOTPRequest, unmarshalValidateUserMFAOTPResponse, unmarshalListGracePeriodsResponse, unmarshalGetUserConnectionsResponse, unmarshalInitiateUserConnectionResponse, marshalJoinUserConnectionRequest, marshalRemoveUserConnectionRequest, unmarshalListApplicationsResponse, marshalCreateApplicationRequest, unmarshalApplication, marshalUpdateApplicationRequest, unmarshalListGroupsResponse, marshalCreateGroupRequest, unmarshalGroup, marshalUpdateGroupRequest, marshalSetGroupMembersRequest, marshalAddGroupMemberRequest, marshalAddGroupMembersRequest, marshalRemoveGroupMemberRequest, unmarshalListPoliciesResponse, marshalCreatePolicyRequest, unmarshalPolicy, marshalUpdatePolicyRequest, marshalSetRulesRequest, unmarshalSetRulesResponse, unmarshalListRulesResponse, unmarshalListPermissionSetsResponse, unmarshalListAPIKeysResponse, marshalCreateAPIKeyRequest, unmarshalAPIKey, marshalUpdateAPIKeyRequest, unmarshalListQuotaResponse, unmarshalQuotum, unmarshalListJWTsResponse, marshalCreateJWTRequest, unmarshalEncodedJWT, unmarshalJWT, unmarshalListLogsResponse, unmarshalLog, unmarshalOrganizationSecuritySettings, marshalUpdateOrganizationSecuritySettingsRequest, marshalSetOrganizationAliasRequest, unmarshalOrganization, marshalUpdateOrganizationLoginMethodsRequest, unmarshalSaml, marshalUpdateSamlRequest, marshalParseSamlMetadataRequest, unmarshalParseSamlMetadataResponse, unmarshalListSamlCertificatesResponse, marshalAddSamlCertificateRequest, unmarshalSamlCertificate, unmarshalScim, unmarshalListScimTokensResponse, unmarshalCreateScimTokenResponse } from "./marshalling.gen.js";
|
|
3
3
|
const jsonContentHeaders = {
|
|
4
4
|
"Content-Type": "application/json; charset=utf-8"
|
|
5
5
|
};
|
|
@@ -618,7 +618,7 @@ class API extends API$1 {
|
|
|
618
618
|
unmarshalPolicy
|
|
619
619
|
);
|
|
620
620
|
/**
|
|
621
|
-
* Get an existing policy. Retrieve information about a policy,
|
|
621
|
+
* Get an existing policy. Retrieve information about a policy, specified by the `policy_id` parameter. The policy's full details, including `id`, `name`, `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets` are returned in the response.
|
|
622
622
|
*
|
|
623
623
|
* @param request - The request {@link GetPolicyRequest}
|
|
624
624
|
* @returns A Promise of Policy
|
|
@@ -1179,6 +1179,87 @@ class API extends API$1 {
|
|
|
1179
1179
|
method: "DELETE",
|
|
1180
1180
|
path: `/iam/v1alpha1/saml-certificates/${validatePathParam("certificateId", request.certificateId)}`
|
|
1181
1181
|
});
|
|
1182
|
+
/**
|
|
1183
|
+
* Get SCIM configuration of an Organization.
|
|
1184
|
+
*
|
|
1185
|
+
* @param request - The request {@link GetOrganizationScimRequest}
|
|
1186
|
+
* @returns A Promise of Scim
|
|
1187
|
+
*/
|
|
1188
|
+
getOrganizationScim = (request = {}) => this.client.fetch(
|
|
1189
|
+
{
|
|
1190
|
+
method: "GET",
|
|
1191
|
+
path: `/iam/v1alpha1/organizations/${validatePathParam("organizationId", request.organizationId ?? this.client.settings.defaultOrganizationId)}/scim`
|
|
1192
|
+
},
|
|
1193
|
+
unmarshalScim
|
|
1194
|
+
);
|
|
1195
|
+
/**
|
|
1196
|
+
* Enable SCIM for an Organization.
|
|
1197
|
+
*
|
|
1198
|
+
* @param request - The request {@link EnableOrganizationScimRequest}
|
|
1199
|
+
* @returns A Promise of Scim
|
|
1200
|
+
*/
|
|
1201
|
+
enableOrganizationScim = (request = {}) => this.client.fetch(
|
|
1202
|
+
{
|
|
1203
|
+
body: "{}",
|
|
1204
|
+
headers: jsonContentHeaders,
|
|
1205
|
+
method: "POST",
|
|
1206
|
+
path: `/iam/v1alpha1/organizations/${validatePathParam("organizationId", request.organizationId ?? this.client.settings.defaultOrganizationId)}/scim`
|
|
1207
|
+
},
|
|
1208
|
+
unmarshalScim
|
|
1209
|
+
);
|
|
1210
|
+
/**
|
|
1211
|
+
* Disable SCIM for an Organization.
|
|
1212
|
+
*
|
|
1213
|
+
* @param request - The request {@link DeleteScimRequest}
|
|
1214
|
+
*/
|
|
1215
|
+
deleteScim = (request) => this.client.fetch({
|
|
1216
|
+
method: "DELETE",
|
|
1217
|
+
path: `/iam/v1alpha1/scim/${validatePathParam("scimId", request.scimId)}`
|
|
1218
|
+
});
|
|
1219
|
+
pageOfListScimTokens = (request) => this.client.fetch(
|
|
1220
|
+
{
|
|
1221
|
+
method: "GET",
|
|
1222
|
+
path: `/iam/v1alpha1/scim/${validatePathParam("scimId", request.scimId)}/tokens`,
|
|
1223
|
+
urlParams: urlParams(
|
|
1224
|
+
["order_by", request.orderBy],
|
|
1225
|
+
["page", request.page],
|
|
1226
|
+
[
|
|
1227
|
+
"page_size",
|
|
1228
|
+
request.pageSize ?? this.client.settings.defaultPageSize
|
|
1229
|
+
]
|
|
1230
|
+
)
|
|
1231
|
+
},
|
|
1232
|
+
unmarshalListScimTokensResponse
|
|
1233
|
+
);
|
|
1234
|
+
/**
|
|
1235
|
+
* List SCIM tokens.
|
|
1236
|
+
*
|
|
1237
|
+
* @param request - The request {@link ListScimTokensRequest}
|
|
1238
|
+
* @returns A Promise of ListScimTokensResponse
|
|
1239
|
+
*/
|
|
1240
|
+
listScimTokens = (request) => enrichForPagination("scimTokens", this.pageOfListScimTokens, request);
|
|
1241
|
+
/**
|
|
1242
|
+
* Create a SCIM token.
|
|
1243
|
+
*
|
|
1244
|
+
* @param request - The request {@link CreateScimTokenRequest}
|
|
1245
|
+
* @returns A Promise of CreateScimTokenResponse
|
|
1246
|
+
*/
|
|
1247
|
+
createScimToken = (request) => this.client.fetch(
|
|
1248
|
+
{
|
|
1249
|
+
method: "POST",
|
|
1250
|
+
path: `/iam/v1alpha1/scim/${validatePathParam("scimId", request.scimId)}/tokens`
|
|
1251
|
+
},
|
|
1252
|
+
unmarshalCreateScimTokenResponse
|
|
1253
|
+
);
|
|
1254
|
+
/**
|
|
1255
|
+
* Delete a SCIM token.
|
|
1256
|
+
*
|
|
1257
|
+
* @param request - The request {@link DeleteScimTokenRequest}
|
|
1258
|
+
*/
|
|
1259
|
+
deleteScimToken = (request) => this.client.fetch({
|
|
1260
|
+
method: "DELETE",
|
|
1261
|
+
path: `/iam/v1alpha1/scim-tokens/${validatePathParam("tokenId", request.tokenId)}`
|
|
1262
|
+
});
|
|
1182
1263
|
}
|
|
1183
1264
|
export {
|
|
1184
1265
|
API
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { API } from './api.gen.js';
|
|
2
2
|
export * from './marshalling.gen.js';
|
|
3
|
-
export type {
|
|
3
|
+
export type { AddGroupMemberRequest, AddGroupMembersRequest, AddSamlCertificateRequest, APIKey, Application, BearerType, ClonePolicyRequest, Connection, ConnectionConnectedOrganization, ConnectionConnectedUser, CreateAPIKeyRequest, CreateApplicationRequest, CreateGroupRequest, CreateJWTRequest, CreatePolicyRequest, CreateScimTokenRequest, CreateScimTokenResponse, CreateSSHKeyRequest, CreateUserMFAOTPRequest, CreateUserRequest, CreateUserRequestMember, DeleteAPIKeyRequest, DeleteApplicationRequest, DeleteGroupRequest, DeleteJWTRequest, DeletePolicyRequest, DeleteSamlCertificateRequest, DeleteSamlRequest, DeleteScimRequest, DeleteScimTokenRequest, DeleteSSHKeyRequest, DeleteUserMFAOTPRequest, DeleteUserRequest, EnableOrganizationSamlRequest, EnableOrganizationScimRequest, EncodedJWT, GetAPIKeyRequest, GetApplicationRequest, GetGroupRequest, GetJWTRequest, GetLogRequest, GetOrganizationRequest, GetOrganizationSamlRequest, GetOrganizationScimRequest, GetOrganizationSecuritySettingsRequest, GetPolicyRequest, GetQuotumRequest, GetSSHKeyRequest, GetUserConnectionsRequest, GetUserConnectionsResponse, GetUserRequest, GracePeriod, GracePeriodType, Group, InitiateUserConnectionRequest, InitiateUserConnectionResponse, JoinUserConnectionRequest, JWT, ListAPIKeysRequest, ListAPIKeysRequestOrderBy, ListAPIKeysResponse, ListApplicationsRequest, ListApplicationsRequestOrderBy, ListApplicationsResponse, ListGracePeriodsRequest, ListGracePeriodsResponse, ListGroupsRequest, ListGroupsRequestOrderBy, ListGroupsResponse, ListJWTsRequest, ListJWTsRequestOrderBy, ListJWTsResponse, ListLogsRequest, ListLogsRequestOrderBy, ListLogsResponse, ListPermissionSetsRequest, ListPermissionSetsRequestOrderBy, ListPermissionSetsResponse, ListPoliciesRequest, ListPoliciesRequestOrderBy, ListPoliciesResponse, ListQuotaRequest, ListQuotaRequestOrderBy, ListQuotaResponse, ListRulesRequest, ListRulesResponse, ListSamlCertificatesRequest, ListSamlCertificatesResponse, ListScimTokensRequest, ListScimTokensRequestOrderBy, ListScimTokensResponse, ListSSHKeysRequest, ListSSHKeysRequestOrderBy, ListSSHKeysResponse, ListUsersRequest, ListUsersRequestOrderBy, ListUsersResponse, LocalityType, LockUserRequest, Log, LogAction, LogResourceType, MFAOTP, Organization, OrganizationSecuritySettings, ParseSamlMetadataRequest, ParseSamlMetadataResponse, PermissionSet, PermissionSetScopeType, Policy, Quotum, QuotumLimit, RemoveGroupMemberRequest, RemoveUserConnectionRequest, Rule, RuleSpecs, Saml, SamlCertificate, SamlCertificateOrigin, SamlCertificateType, SamlServiceProvider, SamlStatus, Scim, ScimToken, SetGroupMembersRequest, SetOrganizationAliasRequest, SetRulesRequest, SetRulesResponse, SSHKey, UnlockUserRequest, UpdateAPIKeyRequest, UpdateApplicationRequest, UpdateGroupRequest, UpdateOrganizationLoginMethodsRequest, UpdateOrganizationSecuritySettingsRequest, UpdatePolicyRequest, UpdateSamlRequest, UpdateSSHKeyRequest, UpdateUserPasswordRequest, UpdateUserRequest, UpdateUserUsernameRequest, User, UserStatus, UserType, ValidateUserMFAOTPRequest, ValidateUserMFAOTPResponse, } from './types.gen.js';
|
|
4
4
|
export * as ValidationRules from './validation-rules.gen.js';
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { API } from "./api.gen.js";
|
|
2
|
-
import { marshalAddGroupMemberRequest, marshalAddGroupMembersRequest, marshalAddSamlCertificateRequest, marshalCreateAPIKeyRequest, marshalCreateApplicationRequest, marshalCreateGroupRequest, marshalCreateJWTRequest, marshalCreatePolicyRequest, marshalCreateSSHKeyRequest, marshalCreateUserRequest, marshalJoinUserConnectionRequest, marshalParseSamlMetadataRequest, marshalRemoveGroupMemberRequest, marshalRemoveUserConnectionRequest, marshalSetGroupMembersRequest, marshalSetOrganizationAliasRequest, marshalSetRulesRequest, marshalUpdateAPIKeyRequest, marshalUpdateApplicationRequest, marshalUpdateGroupRequest, marshalUpdateOrganizationLoginMethodsRequest, marshalUpdateOrganizationSecuritySettingsRequest, marshalUpdatePolicyRequest, marshalUpdateSSHKeyRequest, marshalUpdateSamlRequest, marshalUpdateUserPasswordRequest, marshalUpdateUserRequest, marshalUpdateUserUsernameRequest, marshalValidateUserMFAOTPRequest, unmarshalAPIKey, unmarshalApplication, unmarshalEncodedJWT, unmarshalGetUserConnectionsResponse, unmarshalGroup, unmarshalInitiateUserConnectionResponse, unmarshalJWT, unmarshalListAPIKeysResponse, unmarshalListApplicationsResponse, unmarshalListGracePeriodsResponse, unmarshalListGroupsResponse, unmarshalListJWTsResponse, unmarshalListLogsResponse, unmarshalListPermissionSetsResponse, unmarshalListPoliciesResponse, unmarshalListQuotaResponse, unmarshalListRulesResponse, unmarshalListSSHKeysResponse, unmarshalListSamlCertificatesResponse, unmarshalListUsersResponse, unmarshalLog, unmarshalMFAOTP, unmarshalOrganization, unmarshalOrganizationSecuritySettings, unmarshalParseSamlMetadataResponse, unmarshalPolicy, unmarshalQuotum, unmarshalSSHKey, unmarshalSaml, unmarshalSamlCertificate, unmarshalSetRulesResponse, unmarshalUser, unmarshalValidateUserMFAOTPResponse } from "./marshalling.gen.js";
|
|
2
|
+
import { marshalAddGroupMemberRequest, marshalAddGroupMembersRequest, marshalAddSamlCertificateRequest, marshalCreateAPIKeyRequest, marshalCreateApplicationRequest, marshalCreateGroupRequest, marshalCreateJWTRequest, marshalCreatePolicyRequest, marshalCreateSSHKeyRequest, marshalCreateUserRequest, marshalJoinUserConnectionRequest, marshalParseSamlMetadataRequest, marshalRemoveGroupMemberRequest, marshalRemoveUserConnectionRequest, marshalSetGroupMembersRequest, marshalSetOrganizationAliasRequest, marshalSetRulesRequest, marshalUpdateAPIKeyRequest, marshalUpdateApplicationRequest, marshalUpdateGroupRequest, marshalUpdateOrganizationLoginMethodsRequest, marshalUpdateOrganizationSecuritySettingsRequest, marshalUpdatePolicyRequest, marshalUpdateSSHKeyRequest, marshalUpdateSamlRequest, marshalUpdateUserPasswordRequest, marshalUpdateUserRequest, marshalUpdateUserUsernameRequest, marshalValidateUserMFAOTPRequest, unmarshalAPIKey, unmarshalApplication, unmarshalCreateScimTokenResponse, unmarshalEncodedJWT, unmarshalGetUserConnectionsResponse, unmarshalGroup, unmarshalInitiateUserConnectionResponse, unmarshalJWT, unmarshalListAPIKeysResponse, unmarshalListApplicationsResponse, unmarshalListGracePeriodsResponse, unmarshalListGroupsResponse, unmarshalListJWTsResponse, unmarshalListLogsResponse, unmarshalListPermissionSetsResponse, unmarshalListPoliciesResponse, unmarshalListQuotaResponse, unmarshalListRulesResponse, unmarshalListSSHKeysResponse, unmarshalListSamlCertificatesResponse, unmarshalListScimTokensResponse, unmarshalListUsersResponse, unmarshalLog, unmarshalMFAOTP, unmarshalOrganization, unmarshalOrganizationSecuritySettings, unmarshalParseSamlMetadataResponse, unmarshalPolicy, unmarshalQuotum, unmarshalSSHKey, unmarshalSaml, unmarshalSamlCertificate, unmarshalScim, unmarshalSetRulesResponse, unmarshalUser, unmarshalValidateUserMFAOTPResponse } from "./marshalling.gen.js";
|
|
3
3
|
import * as validationRules_gen from "./validation-rules.gen.js";
|
|
4
4
|
export {
|
|
5
5
|
API,
|
|
@@ -35,6 +35,7 @@ export {
|
|
|
35
35
|
marshalValidateUserMFAOTPRequest,
|
|
36
36
|
unmarshalAPIKey,
|
|
37
37
|
unmarshalApplication,
|
|
38
|
+
unmarshalCreateScimTokenResponse,
|
|
38
39
|
unmarshalEncodedJWT,
|
|
39
40
|
unmarshalGetUserConnectionsResponse,
|
|
40
41
|
unmarshalGroup,
|
|
@@ -52,6 +53,7 @@ export {
|
|
|
52
53
|
unmarshalListRulesResponse,
|
|
53
54
|
unmarshalListSSHKeysResponse,
|
|
54
55
|
unmarshalListSamlCertificatesResponse,
|
|
56
|
+
unmarshalListScimTokensResponse,
|
|
55
57
|
unmarshalListUsersResponse,
|
|
56
58
|
unmarshalLog,
|
|
57
59
|
unmarshalMFAOTP,
|
|
@@ -63,6 +65,7 @@ export {
|
|
|
63
65
|
unmarshalSSHKey,
|
|
64
66
|
unmarshalSaml,
|
|
65
67
|
unmarshalSamlCertificate,
|
|
68
|
+
unmarshalScim,
|
|
66
69
|
unmarshalSetRulesResponse,
|
|
67
70
|
unmarshalUser,
|
|
68
71
|
unmarshalValidateUserMFAOTPResponse
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { DefaultValues } from '@scaleway/sdk-client';
|
|
2
|
-
import type {
|
|
2
|
+
import type { AddGroupMemberRequest, AddGroupMembersRequest, AddSamlCertificateRequest, APIKey, Application, CreateAPIKeyRequest, CreateApplicationRequest, CreateGroupRequest, CreateJWTRequest, CreatePolicyRequest, CreateScimTokenResponse, CreateSSHKeyRequest, CreateUserRequest, EncodedJWT, GetUserConnectionsResponse, Group, InitiateUserConnectionResponse, JoinUserConnectionRequest, JWT, ListAPIKeysResponse, ListApplicationsResponse, ListGracePeriodsResponse, ListGroupsResponse, ListJWTsResponse, ListLogsResponse, ListPermissionSetsResponse, ListPoliciesResponse, ListQuotaResponse, ListRulesResponse, ListSamlCertificatesResponse, ListScimTokensResponse, ListSSHKeysResponse, ListUsersResponse, Log, MFAOTP, Organization, OrganizationSecuritySettings, ParseSamlMetadataRequest, ParseSamlMetadataResponse, Policy, Quotum, RemoveGroupMemberRequest, RemoveUserConnectionRequest, Saml, SamlCertificate, Scim, SetGroupMembersRequest, SetOrganizationAliasRequest, SetRulesRequest, SetRulesResponse, SSHKey, UpdateAPIKeyRequest, UpdateApplicationRequest, UpdateGroupRequest, UpdateOrganizationLoginMethodsRequest, UpdateOrganizationSecuritySettingsRequest, UpdatePolicyRequest, UpdateSamlRequest, UpdateSSHKeyRequest, UpdateUserPasswordRequest, UpdateUserRequest, UpdateUserUsernameRequest, User, ValidateUserMFAOTPRequest, ValidateUserMFAOTPResponse } from './types.gen.js';
|
|
3
3
|
export declare const unmarshalJWT: (data: unknown) => JWT;
|
|
4
4
|
export declare const unmarshalAPIKey: (data: unknown) => APIKey;
|
|
5
5
|
export declare const unmarshalApplication: (data: unknown) => Application;
|
|
@@ -10,6 +10,7 @@ export declare const unmarshalQuotum: (data: unknown) => Quotum;
|
|
|
10
10
|
export declare const unmarshalSSHKey: (data: unknown) => SSHKey;
|
|
11
11
|
export declare const unmarshalSamlCertificate: (data: unknown) => SamlCertificate;
|
|
12
12
|
export declare const unmarshalUser: (data: unknown) => User;
|
|
13
|
+
export declare const unmarshalCreateScimTokenResponse: (data: unknown) => CreateScimTokenResponse;
|
|
13
14
|
export declare const unmarshalEncodedJWT: (data: unknown) => EncodedJWT;
|
|
14
15
|
export declare const unmarshalGetUserConnectionsResponse: (data: unknown) => GetUserConnectionsResponse;
|
|
15
16
|
export declare const unmarshalInitiateUserConnectionResponse: (data: unknown) => InitiateUserConnectionResponse;
|
|
@@ -25,12 +26,14 @@ export declare const unmarshalListQuotaResponse: (data: unknown) => ListQuotaRes
|
|
|
25
26
|
export declare const unmarshalListRulesResponse: (data: unknown) => ListRulesResponse;
|
|
26
27
|
export declare const unmarshalListSSHKeysResponse: (data: unknown) => ListSSHKeysResponse;
|
|
27
28
|
export declare const unmarshalListSamlCertificatesResponse: (data: unknown) => ListSamlCertificatesResponse;
|
|
29
|
+
export declare const unmarshalListScimTokensResponse: (data: unknown) => ListScimTokensResponse;
|
|
28
30
|
export declare const unmarshalListUsersResponse: (data: unknown) => ListUsersResponse;
|
|
29
31
|
export declare const unmarshalMFAOTP: (data: unknown) => MFAOTP;
|
|
30
32
|
export declare const unmarshalOrganization: (data: unknown) => Organization;
|
|
31
33
|
export declare const unmarshalOrganizationSecuritySettings: (data: unknown) => OrganizationSecuritySettings;
|
|
32
34
|
export declare const unmarshalParseSamlMetadataResponse: (data: unknown) => ParseSamlMetadataResponse;
|
|
33
35
|
export declare const unmarshalSaml: (data: unknown) => Saml;
|
|
36
|
+
export declare const unmarshalScim: (data: unknown) => Scim;
|
|
34
37
|
export declare const unmarshalSetRulesResponse: (data: unknown) => SetRulesResponse;
|
|
35
38
|
export declare const unmarshalValidateUserMFAOTPResponse: (data: unknown) => ValidateUserMFAOTPResponse;
|
|
36
39
|
export declare const marshalAddGroupMemberRequest: (request: AddGroupMemberRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
@@ -215,6 +215,30 @@ const unmarshalUser = (data) => {
|
|
|
215
215
|
username: data.username
|
|
216
216
|
};
|
|
217
217
|
};
|
|
218
|
+
const unmarshalScimToken = (data) => {
|
|
219
|
+
if (!isJSONObject(data)) {
|
|
220
|
+
throw new TypeError(
|
|
221
|
+
`Unmarshalling the type 'ScimToken' failed as data isn't a dictionary.`
|
|
222
|
+
);
|
|
223
|
+
}
|
|
224
|
+
return {
|
|
225
|
+
createdAt: unmarshalDate(data.created_at),
|
|
226
|
+
expiresAt: unmarshalDate(data.expires_at),
|
|
227
|
+
id: data.id,
|
|
228
|
+
scimId: data.scim_id
|
|
229
|
+
};
|
|
230
|
+
};
|
|
231
|
+
const unmarshalCreateScimTokenResponse = (data) => {
|
|
232
|
+
if (!isJSONObject(data)) {
|
|
233
|
+
throw new TypeError(
|
|
234
|
+
`Unmarshalling the type 'CreateScimTokenResponse' failed as data isn't a dictionary.`
|
|
235
|
+
);
|
|
236
|
+
}
|
|
237
|
+
return {
|
|
238
|
+
bearerToken: data.bearer_token,
|
|
239
|
+
token: data.token ? unmarshalScimToken(data.token) : void 0
|
|
240
|
+
};
|
|
241
|
+
};
|
|
218
242
|
const unmarshalEncodedJWT = (data) => {
|
|
219
243
|
if (!isJSONObject(data)) {
|
|
220
244
|
throw new TypeError(
|
|
@@ -466,6 +490,17 @@ const unmarshalListSamlCertificatesResponse = (data) => {
|
|
|
466
490
|
)
|
|
467
491
|
};
|
|
468
492
|
};
|
|
493
|
+
const unmarshalListScimTokensResponse = (data) => {
|
|
494
|
+
if (!isJSONObject(data)) {
|
|
495
|
+
throw new TypeError(
|
|
496
|
+
`Unmarshalling the type 'ListScimTokensResponse' failed as data isn't a dictionary.`
|
|
497
|
+
);
|
|
498
|
+
}
|
|
499
|
+
return {
|
|
500
|
+
scimTokens: unmarshalArrayOfObject(data.scim_tokens, unmarshalScimToken),
|
|
501
|
+
totalCount: data.total_count
|
|
502
|
+
};
|
|
503
|
+
};
|
|
469
504
|
const unmarshalListUsersResponse = (data) => {
|
|
470
505
|
if (!isJSONObject(data)) {
|
|
471
506
|
throw new TypeError(
|
|
@@ -554,6 +589,17 @@ const unmarshalSaml = (data) => {
|
|
|
554
589
|
status: data.status
|
|
555
590
|
};
|
|
556
591
|
};
|
|
592
|
+
const unmarshalScim = (data) => {
|
|
593
|
+
if (!isJSONObject(data)) {
|
|
594
|
+
throw new TypeError(
|
|
595
|
+
`Unmarshalling the type 'Scim' failed as data isn't a dictionary.`
|
|
596
|
+
);
|
|
597
|
+
}
|
|
598
|
+
return {
|
|
599
|
+
createdAt: unmarshalDate(data.created_at),
|
|
600
|
+
id: data.id
|
|
601
|
+
};
|
|
602
|
+
};
|
|
557
603
|
const unmarshalSetRulesResponse = (data) => {
|
|
558
604
|
if (!isJSONObject(data)) {
|
|
559
605
|
throw new TypeError(
|
|
@@ -783,6 +829,7 @@ export {
|
|
|
783
829
|
marshalValidateUserMFAOTPRequest,
|
|
784
830
|
unmarshalAPIKey,
|
|
785
831
|
unmarshalApplication,
|
|
832
|
+
unmarshalCreateScimTokenResponse,
|
|
786
833
|
unmarshalEncodedJWT,
|
|
787
834
|
unmarshalGetUserConnectionsResponse,
|
|
788
835
|
unmarshalGroup,
|
|
@@ -800,6 +847,7 @@ export {
|
|
|
800
847
|
unmarshalListRulesResponse,
|
|
801
848
|
unmarshalListSSHKeysResponse,
|
|
802
849
|
unmarshalListSamlCertificatesResponse,
|
|
850
|
+
unmarshalListScimTokensResponse,
|
|
803
851
|
unmarshalListUsersResponse,
|
|
804
852
|
unmarshalLog,
|
|
805
853
|
unmarshalMFAOTP,
|
|
@@ -811,6 +859,7 @@ export {
|
|
|
811
859
|
unmarshalSSHKey,
|
|
812
860
|
unmarshalSaml,
|
|
813
861
|
unmarshalSamlCertificate,
|
|
862
|
+
unmarshalScim,
|
|
814
863
|
unmarshalSetRulesResponse,
|
|
815
864
|
unmarshalUser,
|
|
816
865
|
unmarshalValidateUserMFAOTPResponse
|
|
@@ -10,6 +10,7 @@ export type ListPermissionSetsRequestOrderBy = 'name_asc' | 'name_desc' | 'creat
|
|
|
10
10
|
export type ListPoliciesRequestOrderBy = 'policy_name_asc' | 'policy_name_desc' | 'created_at_asc' | 'created_at_desc';
|
|
11
11
|
export type ListQuotaRequestOrderBy = 'name_asc' | 'name_desc';
|
|
12
12
|
export type ListSSHKeysRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'updated_at_asc' | 'updated_at_desc' | 'name_asc' | 'name_desc';
|
|
13
|
+
export type ListScimTokensRequestOrderBy = 'created_at_asc' | 'created_at_desc';
|
|
13
14
|
export type ListUsersRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'updated_at_asc' | 'updated_at_desc' | 'email_asc' | 'email_desc' | 'last_login_asc' | 'last_login_desc' | 'username_asc' | 'username_desc';
|
|
14
15
|
export type LocalityType = 'global' | 'region' | 'zone';
|
|
15
16
|
export type LogAction = 'unknown_action' | 'created' | 'updated' | 'deleted';
|
|
@@ -118,6 +119,12 @@ export interface RuleSpecs {
|
|
|
118
119
|
*/
|
|
119
120
|
organizationId?: string;
|
|
120
121
|
}
|
|
122
|
+
export interface ScimToken {
|
|
123
|
+
id: string;
|
|
124
|
+
scimId: string;
|
|
125
|
+
createdAt?: Date;
|
|
126
|
+
expiresAt?: Date;
|
|
127
|
+
}
|
|
121
128
|
export interface CreateUserRequestMember {
|
|
122
129
|
/**
|
|
123
130
|
* Email of the user to create.
|
|
@@ -869,6 +876,22 @@ export type CreateSSHKeyRequest = {
|
|
|
869
876
|
*/
|
|
870
877
|
projectId?: string;
|
|
871
878
|
};
|
|
879
|
+
export type CreateScimTokenRequest = {
|
|
880
|
+
/**
|
|
881
|
+
* ID of the SCIM configuration.
|
|
882
|
+
*/
|
|
883
|
+
scimId: string;
|
|
884
|
+
};
|
|
885
|
+
export interface CreateScimTokenResponse {
|
|
886
|
+
/**
|
|
887
|
+
* The SCIM token metadata.
|
|
888
|
+
*/
|
|
889
|
+
token?: ScimToken;
|
|
890
|
+
/**
|
|
891
|
+
* The Bearer Token to use to authenticate to SCIM endpoints.
|
|
892
|
+
*/
|
|
893
|
+
bearerToken: string;
|
|
894
|
+
}
|
|
872
895
|
export type CreateUserMFAOTPRequest = {
|
|
873
896
|
/**
|
|
874
897
|
* User ID of the MFA OTP.
|
|
@@ -942,6 +965,18 @@ export type DeleteSamlRequest = {
|
|
|
942
965
|
*/
|
|
943
966
|
samlId: string;
|
|
944
967
|
};
|
|
968
|
+
export type DeleteScimRequest = {
|
|
969
|
+
/**
|
|
970
|
+
* ID of the SCIM configuration.
|
|
971
|
+
*/
|
|
972
|
+
scimId: string;
|
|
973
|
+
};
|
|
974
|
+
export type DeleteScimTokenRequest = {
|
|
975
|
+
/**
|
|
976
|
+
* The SCIM token ID.
|
|
977
|
+
*/
|
|
978
|
+
tokenId: string;
|
|
979
|
+
};
|
|
945
980
|
export type DeleteUserMFAOTPRequest = {
|
|
946
981
|
/**
|
|
947
982
|
* User ID of the MFA OTP.
|
|
@@ -960,6 +995,12 @@ export type EnableOrganizationSamlRequest = {
|
|
|
960
995
|
*/
|
|
961
996
|
organizationId?: string;
|
|
962
997
|
};
|
|
998
|
+
export type EnableOrganizationScimRequest = {
|
|
999
|
+
/**
|
|
1000
|
+
* ID of the Organization.
|
|
1001
|
+
*/
|
|
1002
|
+
organizationId?: string;
|
|
1003
|
+
};
|
|
963
1004
|
export interface EncodedJWT {
|
|
964
1005
|
/**
|
|
965
1006
|
* The renewed JWT.
|
|
@@ -1016,6 +1057,9 @@ export type GetOrganizationSamlRequest = {
|
|
|
1016
1057
|
*/
|
|
1017
1058
|
organizationId?: string;
|
|
1018
1059
|
};
|
|
1060
|
+
export type GetOrganizationScimRequest = {
|
|
1061
|
+
organizationId?: string;
|
|
1062
|
+
};
|
|
1019
1063
|
export type GetOrganizationSecuritySettingsRequest = {
|
|
1020
1064
|
/**
|
|
1021
1065
|
* ID of the Organization.
|
|
@@ -1526,6 +1570,34 @@ export interface ListSamlCertificatesResponse {
|
|
|
1526
1570
|
*/
|
|
1527
1571
|
certificates: SamlCertificate[];
|
|
1528
1572
|
}
|
|
1573
|
+
export type ListScimTokensRequest = {
|
|
1574
|
+
/**
|
|
1575
|
+
* ID of the SCIM configuration.
|
|
1576
|
+
*/
|
|
1577
|
+
scimId: string;
|
|
1578
|
+
/**
|
|
1579
|
+
* Sort order of SCIM tokens.
|
|
1580
|
+
*/
|
|
1581
|
+
orderBy?: ListScimTokensRequestOrderBy;
|
|
1582
|
+
/**
|
|
1583
|
+
* Requested page number. Value must be greater or equal to 1.
|
|
1584
|
+
*/
|
|
1585
|
+
page?: number;
|
|
1586
|
+
/**
|
|
1587
|
+
* Number of items per page. Value must be between 1 and 100.
|
|
1588
|
+
*/
|
|
1589
|
+
pageSize?: number;
|
|
1590
|
+
};
|
|
1591
|
+
export interface ListScimTokensResponse {
|
|
1592
|
+
/**
|
|
1593
|
+
* List of SCIM tokens.
|
|
1594
|
+
*/
|
|
1595
|
+
scimTokens: ScimToken[];
|
|
1596
|
+
/**
|
|
1597
|
+
* Total count of SCIM tokens.
|
|
1598
|
+
*/
|
|
1599
|
+
totalCount: number;
|
|
1600
|
+
}
|
|
1529
1601
|
export type ListUsersRequest = {
|
|
1530
1602
|
/**
|
|
1531
1603
|
* Criteria for sorting results.
|
|
@@ -1689,6 +1761,16 @@ export interface Saml {
|
|
|
1689
1761
|
*/
|
|
1690
1762
|
singleSignOnUrl: string;
|
|
1691
1763
|
}
|
|
1764
|
+
export interface Scim {
|
|
1765
|
+
/**
|
|
1766
|
+
* ID of the SCIM configuration.
|
|
1767
|
+
*/
|
|
1768
|
+
id: string;
|
|
1769
|
+
/**
|
|
1770
|
+
* Date and time of SCIM configuration creation.
|
|
1771
|
+
*/
|
|
1772
|
+
createdAt?: Date;
|
|
1773
|
+
}
|
|
1692
1774
|
export type SetGroupMembersRequest = {
|
|
1693
1775
|
groupId: string;
|
|
1694
1776
|
userIds: string[];
|
|
@@ -197,6 +197,16 @@ export declare const ListSSHKeysRequest: {
|
|
|
197
197
|
lessThanOrEqual: number;
|
|
198
198
|
};
|
|
199
199
|
};
|
|
200
|
+
export declare const ListScimTokensRequest: {
|
|
201
|
+
page: {
|
|
202
|
+
greaterThanOrEqual: number;
|
|
203
|
+
lessThanOrEqual: number;
|
|
204
|
+
};
|
|
205
|
+
pageSize: {
|
|
206
|
+
greaterThanOrEqual: number;
|
|
207
|
+
lessThanOrEqual: number;
|
|
208
|
+
};
|
|
209
|
+
};
|
|
200
210
|
export declare const ListUsersRequest: {
|
|
201
211
|
page: {
|
|
202
212
|
greaterThanOrEqual: number;
|
|
@@ -64,7 +64,7 @@ const CreateUserRequestMember = {
|
|
|
64
64
|
ignoreEmpty: true
|
|
65
65
|
},
|
|
66
66
|
username: {
|
|
67
|
-
maxLength:
|
|
67
|
+
maxLength: 150,
|
|
68
68
|
minLength: 2,
|
|
69
69
|
pattern: /^[a-zA-Z0-9@._-]+$/
|
|
70
70
|
}
|
|
@@ -197,6 +197,16 @@ const ListSSHKeysRequest = {
|
|
|
197
197
|
lessThanOrEqual: 100
|
|
198
198
|
}
|
|
199
199
|
};
|
|
200
|
+
const ListScimTokensRequest = {
|
|
201
|
+
page: {
|
|
202
|
+
greaterThanOrEqual: 1,
|
|
203
|
+
lessThanOrEqual: 1e4
|
|
204
|
+
},
|
|
205
|
+
pageSize: {
|
|
206
|
+
greaterThanOrEqual: 1,
|
|
207
|
+
lessThanOrEqual: 100
|
|
208
|
+
}
|
|
209
|
+
};
|
|
200
210
|
const ListUsersRequest = {
|
|
201
211
|
page: {
|
|
202
212
|
greaterThanOrEqual: 1,
|
|
@@ -281,7 +291,7 @@ const UpdateUserRequest = {
|
|
|
281
291
|
};
|
|
282
292
|
const UpdateUserUsernameRequest = {
|
|
283
293
|
username: {
|
|
284
|
-
maxLength:
|
|
294
|
+
maxLength: 150,
|
|
285
295
|
minLength: 2,
|
|
286
296
|
pattern: /^[a-zA-Z0-9@._-]+$/
|
|
287
297
|
}
|
|
@@ -311,6 +321,7 @@ export {
|
|
|
311
321
|
ListQuotaRequest,
|
|
312
322
|
ListRulesRequest,
|
|
313
323
|
ListSSHKeysRequest,
|
|
324
|
+
ListScimTokensRequest,
|
|
314
325
|
ListUsersRequest,
|
|
315
326
|
RuleSpecs,
|
|
316
327
|
SetOrganizationAliasRequest,
|