-
Notifications
You must be signed in to change notification settings - Fork 7
/
types.gen.ts
123 lines (122 loc) · 3.63 KB
/
types.gen.ts
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
// Do not modify this file!
// It was generated by the command "yarn codegen".
// Instead update the code generation logic or the OpenAPI document.
import { CursorAndAsyncIterator } from "@cognite/sdk-core";
export interface CursorQueryParameter {
/** @example 4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo */
cursor?: string;
}
/**
* The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
* @format int64
* @min 0
*/
export type EpochTimestamp = number;
/**
* The identity type field indicates the type of principal.
- `USER`: Human user.
- `SERVICE_PRINCIPAL`: Service account.
- `INTERNAL_SERVICE`: Internal CDF service.
*/
export type IdentityType = "USER" | "SERVICE_PRINCIPAL" | "INTERNAL_SERVICE";
/**
* The identity type filter field indicates the type of principal the request should be filtered to show.
If no value is specified, the default value is `USER`.
- `ALL`: All types of principals.
- `USER`: Human user.
- `SERVICE_PRINCIPAL`: Service account.
- `INTERNAL_SERVICE`: Internal CDF service.
*/
export type IdentityTypeFilter = "ALL" | "USER" | "SERVICE_PRINCIPAL" | "INTERNAL_SERVICE";
export interface UserIdentifier {
/** @example abcd */
userIdentifier: string;
}
export interface UserProfileItem {
/**
* The display name for the user.
* @example Jane Doe
*/
displayName?: string | null;
/**
* The user's email address (if any). The email address is is returned directly from
* the identity provider and not guaranteed to be verified.
* Note that the email is mutable and can be updated in the identity provider. It should
* _not_ be used to uniquely identify as a user. Use the `userIdentifier` property instead.
*
* @example jane.doe@example.com
*/
email?: string | null;
/**
* The user's first name.
* @example Jane
*/
givenName?: string | null;
/**
* The identity type field indicates the type of principal.
* - `USER`: Human user.
* - `SERVICE_PRINCIPAL`: Service account.
* - `INTERNAL_SERVICE`: Internal CDF service.
*
*/
identityType?: IdentityType;
/**
* The user's job title.
* @example Software Engineer
*/
jobTitle?: string | null;
/** The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. */
lastUpdatedTime: EpochTimestamp;
/**
* The user's last name.
* @example Doe
*/
surname?: string | null;
/**
* Uniquely identifies the principal the profile is associated with.
* This property is _guaranteed_ to be immutable.
*
* @example abcd
*/
userIdentifier: string;
}
/**
* Array of user identifiers
*/
export interface UserProfilesByIdsRequest {
items?: UserIdentifier[];
}
export interface UserProfilesByIdsResponse {
items?: UserProfileItem[];
}
export interface UserProfilesErrorResponse {
error: {
code: number;
message: string;
missing?: UserIdentifier[];
duplicated?: UserIdentifier[];
};
}
export interface UserProfilesListResponse extends CursorAndAsyncIterator<UserProfileItem> {
}
export interface UserProfilesNotFoundResponse {
error: {
code: number;
message: string;
};
}
export interface UserProfilesSearchRequest {
/**
* <- Limits the maximum number of results to be returned by single request. The default is 25.
* @format int32
* @min 1
* @max 1000
*/
limit?: number;
search?: {
name?: string;
};
}
export interface UserProfilesSearchResponse {
items?: UserProfileItem[];
}