Class: Google::Apis::IamV1::ServiceAccount
- Inherits:
-
Object
- Object
- Google::Apis::IamV1::ServiceAccount
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/iam_v1/classes.rb,
generated/google/apis/iam_v1/representations.rb,
generated/google/apis/iam_v1/representations.rb
Overview
A service account in the Identity and Access Management API.
To create a service account, specify the project_id
and the account_id
for the account. The account_id
is unique within the project, and is used
to generate the service account email address and a stable
unique_id
.
If the account already exists, the account's resource name is returned
in the format of projects/PROJECT_ID
/serviceAccounts/ACCOUNT
. The caller
can use the name in other methods to access the account.
All other methods can identify the service account using the format
projects/
PROJECT_ID/serviceAccounts/
ACCOUNT`.
Using
-as a wildcard for the
PROJECT_IDwill infer the project from
the account. The
ACCOUNTvalue can be the
emailaddress or the
unique_id` of the service account.
Instance Attribute Summary collapse
-
#description ⇒ String
Optional.
-
#disabled ⇒ Boolean
(also: #disabled?)
The field is currently in alpha phase.
-
#display_name ⇒ String
Optional.
-
#email ⇒ String
Corresponds to the JSON property
email
. -
#etag ⇒ String
Optional.
-
#name ⇒ String
The resource name of the service account in the following format:
projects/
PROJECT_ID/serviceAccounts/
ACCOUNT``. -
#oauth2_client_id ⇒ String
This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
-
#project_id ⇒ String
Corresponds to the JSON property
projectId
. -
#unique_id ⇒ String
Corresponds to the JSON property
uniqueId
.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ServiceAccount
constructor
A new instance of ServiceAccount.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ ServiceAccount
Returns a new instance of ServiceAccount
1286 1287 1288 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1286 def initialize(**args) update!(**args) end |
Instance Attribute Details
#description ⇒ String
Optional. A user-specified opaque description of the service account.
Must be less than or equal to 256 UTF-8 bytes.
Corresponds to the JSON property description
1231 1232 1233 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1231 def description @description end |
#disabled ⇒ Boolean Also known as: disabled?
The field is currently in alpha phase.
Corresponds to the JSON property disabled
1237 1238 1239 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1237 def disabled @disabled end |
#display_name ⇒ String
Optional. A user-specified name for the service account.
Must be less than or equal to 100 UTF-8 bytes.
Corresponds to the JSON property displayName
1244 1245 1246 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1244 def display_name @display_name end |
#email ⇒ String
Corresponds to the JSON property email
1249 1250 1251 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1249 def email @email end |
#etag ⇒ String
Optional. Note: etag
is an inoperable legacy field that is only returned
for backwards compatibility.
Corresponds to the JSON property etag
NOTE: Values are automatically base64 encoded/decoded in the client library.
1256 1257 1258 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1256 def etag @etag end |
#name ⇒ String
The resource name of the service account in the following format:
projects/
PROJECT_ID/serviceAccounts/
ACCOUNT.
Requests using `-` as a wildcard for the `PROJECT_ID` will infer the
project from the `account` and the `ACCOUNT` value can be the `email`
address or the `unique_id` of the service account.
In responses the resource name will always be in the format
`projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT
.
Corresponds to the JSON property name
1267 1268 1269 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1267 def name @name end |
#oauth2_client_id ⇒ String
This is used in conjunction with the OAuth2 clientconfig API to make
three legged OAuth2 (3LO) flows to access the data of Google users.
Corresponds to the JSON property oauth2ClientId
1274 1275 1276 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1274 def oauth2_client_id @oauth2_client_id end |
#project_id ⇒ String
Corresponds to the JSON property projectId
1279 1280 1281 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1279 def project_id @project_id end |
#unique_id ⇒ String
Corresponds to the JSON property uniqueId
1284 1285 1286 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1284 def unique_id @unique_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1291 def update!(**args) @description = args[:description] if args.key?(:description) @disabled = args[:disabled] if args.key?(:disabled) @display_name = args[:display_name] if args.key?(:display_name) @email = args[:email] if args.key?(:email) @etag = args[:etag] if args.key?(:etag) @name = args[:name] if args.key?(:name) @oauth2_client_id = args[:oauth2_client_id] if args.key?(:oauth2_client_id) @project_id = args[:project_id] if args.key?(:project_id) @unique_id = args[:unique_id] if args.key?(:unique_id) end |