View Source GoogleApi.IAM.V1.Model.Role (google_api_iam v0.42.0)

A role in the Identity and Access Management API.

Attributes

deleted (type: boolean(), default: nil) - The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
description (type: String.t, default: nil) - Optional. A human-readable description for the role.
etag (type: String.t, default: nil) - Used to perform a consistent read-modify-write.
includedPermissions (type: list(String.t), default: nil) - The names of the permissions this role grants when bound in an IAM policy.
name (type: String.t, default: nil) - The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path. For example, roles/logging.viewer for predefined roles, organizations/{ORGANIZATION_ID}/roles/myRole for organization-level custom roles, and projects/{PROJECT_ID}/roles/myRole for project-level custom roles.
stage (type: String.t, default: nil) - The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
title (type: String.t, default: nil) - Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.IAM.V1.Model.Role{
  deleted: boolean() | nil,
  description: String.t() | nil,
  etag: String.t() | nil,
  includedPermissions: [String.t()] | nil,
  name: String.t() | nil,
  stage: String.t() | nil,
  title: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.