google_api_iam v0.7.0 GoogleApi.IAM.V1.Api.Organizations View Source
API calls for all endpoints tagged Organizations
.
Link to this section Summary
Functions
Creates a new Role.
Soft deletes a role. The role is suspended and cannot be used to create new
IAM Policy Bindings.
The Role will not be included in ListRoles()
unless show_deleted
is set
in the ListRolesRequest
. The Role contains the deleted boolean set.
Existing Bindings remains, but are inactive. The Role can be undeleted
within 7 days. After 7 days the Role is deleted and all Bindings associated
with the role are removed.
Gets a Role definition.
Lists the Roles defined on a resource.
Updates a Role definition.
Undelete a Role, bringing it back in its previous state.
Link to this section Functions
iam_organizations_roles_create(connection, organizations_id, optional_params \\ [], opts \\ [])
View Source
iam_organizations_roles_create(
Tesla.Env.client(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}
iam_organizations_roles_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}
Creates a new Role.
Parameters
connection
(type:GoogleApi.IAM.V1.Connection.t
) - Connection to serverorganizations_id
(type:String.t
) - Part ofparent
. The resource name of the parent resource in one of the following formats:organizations/{ORGANIZATION_ID}
projects/{PROJECT_ID}
optional_params
(type:keyword()
) - Optional parameters:$.xgafv
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.IAM.V1.Model.CreateRoleRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAM.V1.Model.Role{}}
on success{:error, info}
on failure
iam_organizations_roles_delete(connection, organizations_id, roles_id, optional_params \\ [], opts \\ [])
View Source
iam_organizations_roles_delete(
Tesla.Env.client(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}
iam_organizations_roles_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}
Soft deletes a role. The role is suspended and cannot be used to create new
IAM Policy Bindings.
The Role will not be included in ListRoles()
unless show_deleted
is set
in the ListRolesRequest
. The Role contains the deleted boolean set.
Existing Bindings remains, but are inactive. The Role can be undeleted
within 7 days. After 7 days the Role is deleted and all Bindings associated
with the role are removed.
Parameters
connection
(type:GoogleApi.IAM.V1.Connection.t
) - Connection to serverorganizations_id
(type:String.t
) - Part ofname
. The resource name of the role in one of the following formats:organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}
projects/{PROJECT_ID}/roles/{ROLE_NAME}
roles_id
(type:String.t
) - Part ofname
. See documentation oforganizationsId
.optional_params
(type:keyword()
) - Optional parameters:$.xgafv
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:etag
(type:String.t
) - Used to perform a consistent read-modify-write.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAM.V1.Model.Role{}}
on success{:error, info}
on failure
iam_organizations_roles_get(connection, organizations_id, roles_id, optional_params \\ [], opts \\ [])
View Source
iam_organizations_roles_get(
Tesla.Env.client(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}
iam_organizations_roles_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}
Gets a Role definition.
Parameters
connection
(type:GoogleApi.IAM.V1.Connection.t
) - Connection to serverorganizations_id
(type:String.t
) - Part ofname
. The resource name of the role in one of the following formats:roles/{ROLE_NAME}
organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}
projects/{PROJECT_ID}/roles/{ROLE_NAME}
roles_id
(type:String.t
) - Part ofname
. See documentation oforganizationsId
.optional_params
(type:keyword()
) - Optional parameters:$.xgafv
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAM.V1.Model.Role{}}
on success{:error, info}
on failure
iam_organizations_roles_list(connection, organizations_id, optional_params \\ [], opts \\ [])
View Source
iam_organizations_roles_list(
Tesla.Env.client(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.IAM.V1.Model.ListRolesResponse.t()} | {:error, Tesla.Env.t()}
iam_organizations_roles_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.IAM.V1.Model.ListRolesResponse.t()} | {:error, Tesla.Env.t()}
Lists the Roles defined on a resource.
Parameters
connection
(type:GoogleApi.IAM.V1.Connection.t
) - Connection to serverorganizations_id
(type:String.t
) - Part ofparent
. The resource name of the parent resource in one of the following formats:` (empty string) -- this refers to curated roles.
organizations/{ORGANIZATION_ID}projects/{PROJECT_ID}`
optional_params
(type:keyword()
) - Optional parameters:$.xgafv
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type:integer()
) - Optional limit on the number of roles to include in the response.:pageToken
(type:String.t
) - Optional pagination token returned in an earlier ListRolesResponse.:showDeleted
(type:boolean()
) - Include Roles that have been deleted.:view
(type:String.t
) - Optional view for the returned Role objects. WhenFULL
is specified, theincludedPermissions
field is returned, which includes a list of all permissions in the role. The default value isBASIC
, which does not return theincludedPermissions
field.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAM.V1.Model.ListRolesResponse{}}
on success{:error, info}
on failure
iam_organizations_roles_patch(connection, organizations_id, roles_id, optional_params \\ [], opts \\ [])
View Source
iam_organizations_roles_patch(
Tesla.Env.client(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}
iam_organizations_roles_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}
Updates a Role definition.
Parameters
connection
(type:GoogleApi.IAM.V1.Connection.t
) - Connection to serverorganizations_id
(type:String.t
) - Part ofname
. The resource name of the role in one of the following formats:roles/{ROLE_NAME}
organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}
projects/{PROJECT_ID}/roles/{ROLE_NAME}
roles_id
(type:String.t
) - Part ofname
. See documentation oforganizationsId
.optional_params
(type:keyword()
) - Optional parameters:$.xgafv
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:updateMask
(type:String.t
) - A mask describing which fields in the Role have changed.:body
(type:GoogleApi.IAM.V1.Model.Role.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAM.V1.Model.Role{}}
on success{:error, info}
on failure
iam_organizations_roles_undelete(connection, organizations_id, roles_id, optional_params \\ [], opts \\ [])
View Source
iam_organizations_roles_undelete(
Tesla.Env.client(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}
iam_organizations_roles_undelete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}
Undelete a Role, bringing it back in its previous state.
Parameters
connection
(type:GoogleApi.IAM.V1.Connection.t
) - Connection to serverorganizations_id
(type:String.t
) - Part ofname
. The resource name of the role in one of the following formats:organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}
projects/{PROJECT_ID}/roles/{ROLE_NAME}
roles_id
(type:String.t
) - Part ofname
. See documentation oforganizationsId
.optional_params
(type:keyword()
) - Optional parameters:$.xgafv
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.IAM.V1.Model.UndeleteRoleRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAM.V1.Model.Role{}}
on success{:error, info}
on failure