azureuser : Azure User object.¶
An Azure user object represents a specific client id and client secret pair credentials of an Azure user.
Object Reference¶
References to azureuser are object references.
The name part of the name server group object reference has the following components:
Client ID of the Azure user
Example: azureuser/b25lLmF6dXJlX3VzZXIkMjg5N:289623f5-c9f1-42ab-b458-6f3130b92b01
Restrictions¶
The object does not support the following operations:
Scheduling
CSV export
The object cannot be managed on Cloud Platform members.
Fields¶
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): client_id, name, tenant_id.
The following fields are required to create this object:
Field |
Notes |
|---|---|
client_id |
|
client_secret_key |
|
name |
|
tenant_id |
client_id¶
- client_id¶
The unique Client ID of this Azure user. Maximum 255 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The client_id is part of the base object.
client_secret_key¶
- client_secret_key¶
The Client Secret Key for the Client ID of this user. Maximum 255 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is not available for search.
Notes
client_secret_key is not readable.
last_used¶
- last_used¶
The timestamp when this Azure user credentials was last used.
Type
Timestamp.
Search
The field is not available for search.
Notes
The last_used cannot be updated.
last_used cannot be written.
name¶
- name¶
The Azure user name. Maximum 64 characters.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The name is part of the base object.
status¶
- status¶
Indicate the validity status of this Azure user.
Type
String.
- Valid values are:
SUCCESSFUL
UNSUCCESSFUL
UNUSED
Search
The field is available for search via
‘=’ (exact equality)
Notes
The status cannot be updated.
status cannot be written.
tenant_id¶
- tenant_id¶
The Azure Tenant ID of this Azure user. Maximum 64 characters.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The tenant_id is part of the base object.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
client_id |
String |
Y |
N |
Y |
= |
client_secret_key |
String |
Y |
N |
N |
N/A |
last_used |
Timestamp |
N |
Y |
N |
N/A |
name |
String |
Y |
N |
Y |
: = ~ |
status |
String |
N |
Y |
N |
= |
tenant_id |
String |
Y |
N |
Y |
= |
