Class: Azure::GraphRbac::V1_6::Models::User

Inherits:
DirectoryObject show all
Includes:
MsRestAzure
Defined in:
lib/1.6/generated/azure_graph_rbac/models/user.rb

Overview

Active Directory user information.

Instance Attribute Summary collapse

Attributes inherited from DirectoryObject

#additional_properties, #deletion_timestamp, #object_id

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ User

Returns a new instance of User.



16
17
18
 
# File 'lib/1.6/generated/azure_graph_rbac/models/user.rb', line 16

def initialize
  @objectType = "User"
end

Instance Attribute Details

#account_enabled ⇒ Boolean

Returns Whether the account is enabled.

Returns:

  • (Boolean) —

    Whether the account is enabled.



46
47
48
 
# File 'lib/1.6/generated/azure_graph_rbac/models/user.rb', line 46

def 
  @account_enabled
end

#display_name ⇒ String

Returns The display name of the user.

Returns:

  • (String) —

    The display name of the user.



49
50
51
 
# File 'lib/1.6/generated/azure_graph_rbac/models/user.rb', line 49

def display_name
  @display_name
end

#given_name ⇒ String

Returns The given name for the user.

Returns:

  • (String) —

    The given name for the user.



35
36
37
 
# File 'lib/1.6/generated/azure_graph_rbac/models/user.rb', line 35

def given_name
  @given_name
end

#immutable_id ⇒ String

domain for the user’s userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.

Returns:

  • (String) —

    This must be specified if you are using a federated



26
27
28
 
# File 'lib/1.6/generated/azure_graph_rbac/models/user.rb', line 26

def immutable_id
  @immutable_id
end

#mail ⇒ String

Returns The primary email address of the user.

Returns:

  • (String) —

    The primary email address of the user.



58
59
60
 
# File 'lib/1.6/generated/azure_graph_rbac/models/user.rb', line 58

def mail
  @mail
end

#mail_nickname ⇒ String

Returns The mail alias for the user.

Returns:

  • (String) —

    The mail alias for the user.



55
56
57
 
# File 'lib/1.6/generated/azure_graph_rbac/models/user.rb', line 55

def mail_nickname
  @mail_nickname
end

#objectType ⇒ Object

Returns the value of attribute objectType.



20
21
22
 
# File 'lib/1.6/generated/azure_graph_rbac/models/user.rb', line 20

def objectType
  @objectType
end

#sign_in_names ⇒ Array<SignInName>

Returns The sign-in names of the user.

Returns:

  • (Array<SignInName>) —

    The sign-in names of the user.



61
62
63
 
# File 'lib/1.6/generated/azure_graph_rbac/models/user.rb', line 61

def 
  @sign_in_names
end

#surname ⇒ String

Returns The user’s surname (family name or last name).

Returns:

  • (String) —

    The user’s surname (family name or last name).



38
39
40
 
# File 'lib/1.6/generated/azure_graph_rbac/models/user.rb', line 38

def surname
  @surname
end

#usage_location ⇒ String

Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: “US”, “JP”, and “GB”.

Returns:

  • (String) —

    A two letter country code (ISO standard 3166).



32
33
34
 
# File 'lib/1.6/generated/azure_graph_rbac/models/user.rb', line 32

def usage_location
  @usage_location
end

#user_principal_name ⇒ String

Returns The principal name of the user.

Returns:

  • (String) —

    The principal name of the user.



52
53
54
 
# File 'lib/1.6/generated/azure_graph_rbac/models/user.rb', line 52

def user_principal_name
  @user_principal_name
end

#user_type ⇒ UserType

types in your directory, such as ‘Member’ and ‘Guest’. Possible values include: ‘Member’, ‘Guest’

Returns:

  • (UserType) —

    A string value that can be used to classify user



43
44
45
 
# File 'lib/1.6/generated/azure_graph_rbac/models/user.rb', line 43

def user_type
  @user_type
end

Class Method Details

.mapper ⇒ Object

Mapper for User class as Ruby Hash. This will be used for serialization/deserialization.



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
 
# File 'lib/1.6/generated/azure_graph_rbac/models/user.rb', line 68

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'User',
    type: {
      name: 'Composite',
      class_name: 'User',
      model_properties: {
        additional_properties: {
          client_side_validation: true,
          required: false,
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ObjectElementType',
                type: {
                  name: 'Object'
                }
            }
          }
        },
        object_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'objectId',
          type: {
            name: 'String'
          }
        },
        deletion_timestamp: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'deletionTimestamp',
          type: {
            name: 'DateTime'
          }
        },
        objectType: {
          client_side_validation: true,
          required: true,
          serialized_name: 'objectType',
          type: {
            name: 'String'
          }
        },
        immutable_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'immutableId',
          type: {
            name: 'String'
          }
        },
        usage_location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'usageLocation',
          type: {
            name: 'String'
          }
        },
        given_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'givenName',
          type: {
            name: 'String'
          }
        },
        surname: {
          client_side_validation: true,
          required: false,
          serialized_name: 'surname',
          type: {
            name: 'String'
          }
        },
        user_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'userType',
          type: {
            name: 'String'
          }
        },
        account_enabled: {
          client_side_validation: true,
          required: false,
          serialized_name: 'accountEnabled',
          type: {
            name: 'Boolean'
          }
        },
        display_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'displayName',
          type: {
            name: 'String'
          }
        },
        user_principal_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'userPrincipalName',
          type: {
            name: 'String'
          }
        },
        mail_nickname: {
          client_side_validation: true,
          required: false,
          serialized_name: 'mailNickname',
          type: {
            name: 'String'
          }
        },
        mail: {
          client_side_validation: true,
          required: false,
          serialized_name: 'mail',
          type: {
            name: 'String'
          }
        },
        sign_in_names: {
          client_side_validation: true,
          required: false,
          serialized_name: 'signInNames',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'SignInNameElementType',
                type: {
                  name: 'Composite',
                  class_name: 'SignInName'
                }
            }
          }
        }
      }
    }
  }
end