/
user.go
143 lines (117 loc) · 7.12 KB
/
user.go
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
// Copyright (c) 2016, 2018, 2021, Oracle and/or its affiliates. All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.
// Identity and Access Management Service API
//
// APIs for managing users, groups, compartments, and policies.
//
package identity
import (
"github.com/oracle/oci-go-sdk/v35/common"
)
// User An individual employee or system that needs to manage or use your company's Oracle Cloud Infrastructure
// resources. Users might need to launch instances, manage remote disks, work with your cloud network, etc. Users
// have one or more IAM Service credentials (ApiKey,
// UIPassword, SwiftPassword and
// AuthToken).
// For more information, see User Credentials (https://docs.cloud.oracle.com/Content/Identity/Concepts/usercredentials.htm)). End users of your
// application are not typically IAM Service users. For conceptual information about users and other IAM Service
// components, see Overview of the IAM Service (https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm).
// These users are created directly within the Oracle Cloud Infrastructure system, via the IAM service.
// They are different from *federated users*, who authenticate themselves to the Oracle Cloud Infrastructure
// Console via an identity provider. For more information, see
// Identity Providers and Federation (https://docs.cloud.oracle.com/Content/Identity/Concepts/federation.htm).
// To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
// talk to an administrator. If you're an administrator who needs to write policies to give users access,
// see Getting Started with Policies (https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
// **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values
// using the API.
type User struct {
// The OCID of the user.
Id *string `mandatory:"true" json:"id"`
// The OCID of the tenancy containing the user.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name you assign to the user during creation. This is the user's login for the Console.
// The name must be unique across all users in the tenancy and cannot be changed.
Name *string `mandatory:"true" json:"name"`
// The description you assign to the user. Does not have to be unique, and it's changeable.
Description *string `mandatory:"true" json:"description"`
// Date and time the user was created, in the format defined by RFC3339.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The user's current state. After creating a user, make sure its `lifecycleState` changes from CREATING to
// ACTIVE before using it.
LifecycleState UserLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Flag indicates if MFA has been activated for the user.
IsMfaActivated *bool `mandatory:"true" json:"isMfaActivated"`
// The email address you assign to the user.
// The email address must be unique across all users in the tenancy.
Email *string `mandatory:"false" json:"email"`
// Whether the email address has been validated.
EmailVerified *bool `mandatory:"false" json:"emailVerified"`
// The OCID of the `IdentityProvider` this user belongs to.
IdentityProviderId *string `mandatory:"false" json:"identityProviderId"`
// Identifier of the user in the identity provider
ExternalIdentifier *string `mandatory:"false" json:"externalIdentifier"`
// Returned only if the user's `lifecycleState` is INACTIVE. A 16-bit value showing the reason why the user
// is inactive:
// - bit 0: SUSPENDED (reserved for future use)
// - bit 1: DISABLED (reserved for future use)
// - bit 2: BLOCKED (the user has exceeded the maximum number of failed login attempts for the Console)
InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
Capabilities *UserCapabilities `mandatory:"false" json:"capabilities"`
// The date and time of when the user most recently logged in the
// format defined by RFC3339 (ex. `2016-08-25T21:10:29.600Z`).
// If there is no login history, this field is null.
// For illustrative purposes, suppose we have a user who has logged in
// at July 1st, 2020 at 1200 PST and logged out 30 minutes later.
// They then login again on July 2nd, 2020 at 1500 PST.
// Their previousSuccessfulLoginTime would be `2020-07-01:19:00.000Z`.
// Their lastSuccessfulLoginTime would be `2020-07-02:22:00.000Z`.
LastSuccessfulLoginTime *common.SDKTime `mandatory:"false" json:"lastSuccessfulLoginTime"`
// The date and time of when the user most recently logged in the
// format defined by RFC3339 (ex. `2016-08-25T21:10:29.600Z`).
// If there is no login history, this field is null.
// For illustrative purposes, suppose we have a user who has logged in
// at July 1st, 2020 at 1200 PST and logged out 30 minutes later.
// They then login again on July 2nd, 2020 at 1500 PST.
// Their previousSuccessfulLoginTime would be `2020-07-01:19:00.000Z`.
// Their lastSuccessfulLoginTime would be `2020-07-02:22:00.000Z`.
PreviousSuccessfulLoginTime *common.SDKTime `mandatory:"false" json:"previousSuccessfulLoginTime"`
}
func (m User) String() string {
return common.PointerString(m)
}
// UserLifecycleStateEnum Enum with underlying type: string
type UserLifecycleStateEnum string
// Set of constants representing the allowable values for UserLifecycleStateEnum
const (
UserLifecycleStateCreating UserLifecycleStateEnum = "CREATING"
UserLifecycleStateActive UserLifecycleStateEnum = "ACTIVE"
UserLifecycleStateInactive UserLifecycleStateEnum = "INACTIVE"
UserLifecycleStateDeleting UserLifecycleStateEnum = "DELETING"
UserLifecycleStateDeleted UserLifecycleStateEnum = "DELETED"
)
var mappingUserLifecycleState = map[string]UserLifecycleStateEnum{
"CREATING": UserLifecycleStateCreating,
"ACTIVE": UserLifecycleStateActive,
"INACTIVE": UserLifecycleStateInactive,
"DELETING": UserLifecycleStateDeleting,
"DELETED": UserLifecycleStateDeleted,
}
// GetUserLifecycleStateEnumValues Enumerates the set of values for UserLifecycleStateEnum
func GetUserLifecycleStateEnumValues() []UserLifecycleStateEnum {
values := make([]UserLifecycleStateEnum, 0)
for _, v := range mappingUserLifecycleState {
values = append(values, v)
}
return values
}