Create Role
const url = 'https://example.com/iam/v1/roles';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"name":"example","description":"example","scope_type":"SCOPE_TYPE_UNSPECIFIED","scope_id":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/iam/v1/roles \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "description": "example", "scope_type": "SCOPE_TYPE_UNSPECIFIED", "scope_id": "example" }'Creates a new role
Request Body required
Section titled “Request Body required ”Role resource — a named collection of permissions assignable to principals
object
The unique identifier of the role
The display name of the role
An optional description of the role
The type of role (system or custom)
The lifecycle stage of the role
The type of scope this role is defined in (only for custom roles)
The ID of the scoped resource (only for custom roles)
Created Timestamp
The timestamp when the role was created
Updated Timestamp
Timestamp when the Role was last updated
Responses
Section titled “ Responses ”OK
IAM Operation
An acknowledgment of a mutation request, carrying tracking metadata, errors, and warnings. Follows GCP’s Operations pattern (AIP-151).
object
Operation ID
Unique identifier for this operation.
Resource ID
The ID of the resource affected by this operation. May be empty for async operations where the resource does not yet exist.
Resource Type
The type of resource (e.g., “User”, “Role”, “IamBinding”).
Operation Type
The kind of mutation that was requested.
Status
Current lifecycle state of the operation.
Insert Time
When the operation was first created.
Start Time
When the operation started executing.
End Time
When the operation completed (either successfully or with errors).
Errors
Business rule errors encountered during the operation.
Operation Error
A structured error returned inside an operation when a business rule fails.
object
Error Code
Numeric identifier following the S_SSS_EEE convention.
Description
Human-readable explanation of the error.
Warnings
Non-fatal notices about the operation.
Operation Warning
A non-fatal notice attached to an operation.
object
Warning Code
Numeric identifier following the S_SSS_EEE convention.
Description
Human-readable explanation of the warning.
Progress
Percentage of completion (0-100).
Revocation Cause
Discriminator for REVOKE operations only (UNSPECIFIED for every other operation_type). See RevocationCause for the four flavours.
Example
{ "operation_type": "IAM_OPERATION_TYPE_UNSPECIFIED", "status": "IAM_OPERATION_STATUS_UNSPECIFIED", "cause": "REVOCATION_CAUSE_UNSPECIFIED"}default
Section titled “default ”Default error response
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}