REST Resource: permissions
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Permissions
| JSON representation |
{
"issuerId": string,
"permissions": [
{
object (Permission)
}
]
} |
| Fields |
issuerId |
string (int64 format)
ID of the issuer the list of permissions refer to.
|
permissions[] |
object (Permission)
The complete list of permissions for the issuer account.
|
Permission
| JSON representation |
{
"emailAddress": string,
"role": enum (Role)
} |
| Fields |
emailAddress |
string
The email address of the user, group, or service account to which this permission refers to.
|
role |
enum (Role)
The role granted by this permission.
|
Role
| Enums |
ROLE_UNSPECIFIED |
|
OWNER |
|
owner |
Legacy alias for OWNER. Deprecated. |
READER |
|
reader |
Legacy alias for READER. Deprecated. |
WRITER |
|
writer |
Legacy alias for WRITER. Deprecated. |
Methods |
|
|
Returns the permissions for the given issuer id. |
|
|
Updates the permissions for the given issuer. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-13 UTC.
[null,null,["Last updated 2025-03-13 UTC."],[[["\u003cp\u003ePermissions define access levels (OWNER, READER, WRITER) for users, groups, or service accounts associated with an issuer ID.\u003c/p\u003e\n"],["\u003cp\u003ePermissions can be managed through the \u003ccode\u003eget\u003c/code\u003e and \u003ccode\u003eupdate\u003c/code\u003e methods to retrieve and modify access rights.\u003c/p\u003e\n"],["\u003cp\u003ePermissions are structured with an issuer ID and an array of individual permissions, each specifying an email address and a role.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePermissions\u003c/code\u003e resource provides a comprehensive list of permissions for a given issuer, enabling centralized access control.\u003c/p\u003e\n"]]],["Permissions are managed for an issuer, identified by an `issuerId`. The permission structure includes a list of `permissions`, each specifying an `emailAddress` and a granted `role`. Roles can be `OWNER`, `READER`, or `WRITER`; lowercase versions are deprecated aliases. Permissions can be retrieved using the `get` method by issuer id. The `update` method allows modifying the permissions list associated with a specified issuer.\n"],null,["# REST Resource: permissions\n\n- [Resource: Permissions](#Permissions)\n - [JSON representation](#Permissions.SCHEMA_REPRESENTATION)\n- [Permission](#Permission)\n - [JSON representation](#Permission.SCHEMA_REPRESENTATION)\n- [Role](#Role)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Permissions\n---------------------\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------|\n| ``` { \"issuerId\": string, \"permissions\": [ { object (/wallet/reference/rest/v1/permissions#Permission) } ] } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `issuerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` ID of the issuer the list of permissions refer to. |\n| `permissions[]` | `object (`[Permission](/wallet/reference/rest/v1/permissions#Permission)`)` The complete list of permissions for the issuer account. |\n\nPermission\n----------\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------|\n| ``` { \"emailAddress\": string, \"role\": enum (/wallet/reference/rest/v1/permissions#Role) } ``` |\n\n| Fields ||\n|----------------|-------------------------------------------------------------------------------------------------------|\n| `emailAddress` | `string` The email address of the user, group, or service account to which this permission refers to. |\n| `role` | `enum (`[Role](/wallet/reference/rest/v1/permissions#Role)`)` The role granted by this permission. |\n\nRole\n----\n\n| Enums ||\n|--------------------|-------------------------------------------------------------------|\n| `ROLE_UNSPECIFIED` | |\n| `OWNER` | |\n| `owner` | Legacy alias for `OWNER`. Deprecated. | This item is deprecated! |\n| `READER` | |\n| `reader` | Legacy alias for `READER`. Deprecated. | This item is deprecated! |\n| `WRITER` | |\n| `writer` | Legacy alias for `WRITER`. Deprecated. | This item is deprecated! |\n\n| Methods ------- ||\n|------------------------------------------------------------|--------------------------------------------------|\n| ### [get](/wallet/reference/rest/v1/permissions/get) | Returns the permissions for the given issuer id. |\n| ### [update](/wallet/reference/rest/v1/permissions/update) | Updates the permissions for the given issuer. |"]]
