Retrieve a specific role
Fetch the details of a specific role by providing its unique ID.
GET
Parameters
Path Parameters
OrganizationId
REQUIRED
Unique identifier of the organization
RoleId
REQUIRED
Unique identifier of the organization role
| Status code | Description |
|---|---|
| 200 | Successfully retrieved the role details. |
| 400 | Bad request error - the request contains invalid parameters or malformed data |
| 500 | Internal server error - an unexpected error occurred on the server |
cURL
curl -L \"https://blockv-labs.io/organizations/{organizationId}/roles/{roleId}" \-H 'Accept: application/json'
Response
{"id": "string","name": "string","description": "string","permissions": [{"resource": "api-keys","crud": {"read": false,"create": false,"update": false,"delete": false}}],"when_created": "2024-01-01T00:00:00Z","when_modified": "2024-01-01T00:00:00Z"}
json
{"type": "object","required": ["id","name","permissions","when_created","when_modified"],"properties": {"id": {"type": "string","description": "Unique identifier for the role","x-oapi-codegen-extra-tags": {"json": "id,omitempty","bson": "_id,omitempty"},"x-go-type": "id.ID","x-go-type-import": {"path": "github.com/vlabsio/smarttoken/pkg/types/id"}},"name": {"type": "string","description": "Human-readable name of the role","x-oapi-codegen-extra-tags": {"bson": "name,omitempty"}},"description": {"type": "string","description": "Optional detailed description of the role's purpose and scope","x-oapi-codegen-extra-tags": {"bson": "description,omitempty"},"x-go-type-skip-optional-pointer": true},"permissions": {"type": "array","description": "List of permissions assigned to this role","x-oapi-codegen-extra-tags": {"bson": "permissions,omitempty"},"items": {"type": "object","required": ["resource","crud"],"properties": {"resource": {"type": "string","x-oapi-codegen-extra-tags": {"bson": "resource,omitempty"},"enum": ["api-keys","ebus.actions","ebus.action-logs","faces","faces.pages","faces.assistant","indexer","notifications.templates","notifications.messages","objects","objects.state-changes","organizations","organizations.members","organizations.roles","sequencer.batches","stats.wallets","stats.objects","stats.actions","storage","templates","wallets","webhooks"]},"crud": {"type": "object","x-oapi-codegen-extra-tags": {"bson": "crud,omitempty"},"required": ["read","create","update","delete"],"properties": {"read": {"type": "boolean","x-oapi-codegen-extra-tags": {"bson": "read,omitempty"}},"create": {"type": "boolean","x-oapi-codegen-extra-tags": {"bson": "create,omitempty"}},"update": {"type": "boolean","x-oapi-codegen-extra-tags": {"bson": "update,omitempty"}},"delete": {"type": "boolean","x-oapi-codegen-extra-tags": {"bson": "delete,omitempty"}}}}}}},"when_created": {"type": "string","description": "Timestamp when the role was created","x-oapi-codegen-extra-tags": {"bson": "when_created,omitempty"},"format": "date-time"},"when_modified": {"type": "string","description": "Timestamp when the role was last modified","x-oapi-codegen-extra-tags": {"bson": "when_modified,omitempty"},"format": "date-time"}}}