gcpuser : GCP User object.¶
An GCP user object represents a specific client id and client secret pair credentials of an GCP user.
Object Reference¶
References to gcpuser are object references.
The name part of the name server group object reference has the following components:
Client ID of the GCP user
Example: gcpuser/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): auth_provider_x509_cert_url, auth_uri, client_email, client_id, client_x509_cert_url, file_name, private_key_id, project_id, token_uri, type, user_name.
The following fields are required to create this object:
Field |
Notes |
|---|---|
user_name |
auth_provider_x509_cert_url¶
- auth_provider_x509_cert_url¶
The URL where the public key certificates provided by the authentication provider can be retrieved.. Maximum 255 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The auth_provider_x509_cert_url is part of the base object.
The auth_provider_x509_cert_url cannot be updated.
auth_provider_x509_cert_url cannot be written.
auth_uri¶
- auth_uri¶
The URI where authentication requests should be directed.. Maximum 255 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The auth_uri is part of the base object.
The auth_uri cannot be updated.
auth_uri cannot be written.
client_email¶
- client_email¶
The email address associated with the service account. Maximum 255 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The client_email is part of the base object.
The client_email cannot be updated.
client_email cannot be written.
client_id¶
- client_id¶
The unique identifier for the service account. Maximum 64 characts.er
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The client_id is part of the base object.
The client_id cannot be updated.
client_id cannot be written.
client_x509_cert_url¶
- client_x509_cert_url¶
The URL where the public key certificate for the service account can be retrieved. Maximum 255 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The client_x509_cert_url is part of the base object.
The client_x509_cert_url cannot be updated.
client_x509_cert_url cannot be written.
file_name¶
- file_name¶
GCP client credentials file name.. Maximum 255 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The file_name is part of the base object.
The file_name cannot be updated.
file_name cannot be written.
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.
private_key¶
- private_key¶
The private key used for authentication. Maximum 255 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is not available for search.
Notes
The private_key cannot be updated.
private_key cannot be written.
private_key_id¶
- private_key_id¶
The identifier for the private key associated with the service account. Maximum 64 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The private_key_id is part of the base object.
The private_key_id cannot be updated.
private_key_id cannot be written.
project_id¶
- project_id¶
The ID of the GCP project associated with the service account. Maximum 64 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The project_id is part of the base object.
The project_id cannot be updated.
project_id cannot be written.
status¶
- status¶
Indicate the validity status of this GCP 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.
token_uri¶
- token_uri¶
The URI where token requests should be directed.. Maximum 255 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The token_uri is part of the base object.
The token_uri cannot be updated.
token_uri cannot be written.
type¶
- type¶
Specifies the type of the credential. Maximum 255 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The type is part of the base object.
The type cannot be updated.
type cannot be written.
user_name¶
- user_name¶
The GCP client’s 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 user_name is part of the base object.
user_name is not readable.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
auth_provider_x509_cert_url |
String |
N |
Y |
Y |
= |
auth_uri |
String |
N |
Y |
Y |
= |
client_email |
String |
N |
Y |
Y |
= |
client_id |
String |
N |
Y |
Y |
: = ~ |
client_x509_cert_url |
String |
N |
Y |
Y |
= |
file_name |
String |
N |
Y |
Y |
: = ~ |
last_used |
Timestamp |
N |
Y |
N |
N/A |
private_key |
String |
N |
Y |
N |
N/A |
private_key_id |
String |
N |
Y |
Y |
= |
project_id |
String |
N |
Y |
Y |
: = ~ |
status |
String |
N |
Y |
N |
= |
token_uri |
String |
N |
Y |
Y |
= |
type |
String |
N |
Y |
Y |
= |
user_name |
String |
Y |
N |
Y |
: = ~ |
