> For the complete documentation index, see [llms.txt](https://dev.guardian.hedera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.guardian.hedera.com/static-spec-test/customization/themes.md).

# Themes

## Returns a list of all themes.

> Returns a list of all themes. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"themes"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ThemeDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"createDate":{"type":"string","description":"Creation date in ISO 8601 format"},"updateDate":{"type":"string","description":"Last update date in ISO 8601 format"},"uuid":{"type":"string","description":"Unique universal identifier"},"owner":{"type":"string","description":"DID of the theme owner"},"name":{"type":"string","description":"Theme name"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/ThemeRoleDTO"}}},"required":["id","createDate","updateDate","uuid","owner","name","rules"]},"ThemeRoleDTO":{"type":"object","properties":{"description":{"type":"string"},"text":{"type":"string","description":"Text color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"background":{"type":"string","description":"Background color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"border":{"type":"string","description":"Border color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"shape":{"type":"string","description":"Object shape","enum":["0","1","2","3","4","5"]},"borderWidth":{"type":"string","description":"Border width","enum":["0px","1px","2px","3px","4px","5px","6px","7px"]},"filterType":{"type":"string","description":"Filter by type","enum":["type","api","role"]},"filterValue":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["description","text","background","border","shape","borderWidth","filterType","filterValue"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/themes":{"get":{"description":"Returns a list of all themes. Only users with the Standard Registry role are allowed to make the request.","operationId":"ThemesApi_getThemes","parameters":[],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ThemeDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Returns a list of all themes.","tags":["themes"]}}}}
```

## Creates a new theme.

> Creates a new theme. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"themes"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ThemeDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"createDate":{"type":"string","description":"Creation date in ISO 8601 format"},"updateDate":{"type":"string","description":"Last update date in ISO 8601 format"},"uuid":{"type":"string","description":"Unique universal identifier"},"owner":{"type":"string","description":"DID of the theme owner"},"name":{"type":"string","description":"Theme name"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/ThemeRoleDTO"}}},"required":["id","createDate","updateDate","uuid","owner","name","rules"]},"ThemeRoleDTO":{"type":"object","properties":{"description":{"type":"string"},"text":{"type":"string","description":"Text color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"background":{"type":"string","description":"Background color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"border":{"type":"string","description":"Border color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"shape":{"type":"string","description":"Object shape","enum":["0","1","2","3","4","5"]},"borderWidth":{"type":"string","description":"Border width","enum":["0px","1px","2px","3px","4px","5px","6px","7px"]},"filterType":{"type":"string","description":"Filter by type","enum":["type","api","role"]},"filterValue":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["description","text","background","border","shape","borderWidth","filterType","filterValue"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/themes":{"post":{"description":"Creates a new theme. Only users with the Standard Registry role are allowed to make the request.","operationId":"ThemesApi_setThemes","parameters":[],"requestBody":{"required":true,"description":"Object that contains a theme.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeDTO"}}}},"responses":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Creates a new theme.","tags":["themes"]}}}}
```

## Updates theme configuration.

> Updates theme configuration for the specified theme ID. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"themes"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ThemeDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"createDate":{"type":"string","description":"Creation date in ISO 8601 format"},"updateDate":{"type":"string","description":"Last update date in ISO 8601 format"},"uuid":{"type":"string","description":"Unique universal identifier"},"owner":{"type":"string","description":"DID of the theme owner"},"name":{"type":"string","description":"Theme name"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/ThemeRoleDTO"}}},"required":["id","createDate","updateDate","uuid","owner","name","rules"]},"ThemeRoleDTO":{"type":"object","properties":{"description":{"type":"string"},"text":{"type":"string","description":"Text color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"background":{"type":"string","description":"Background color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"border":{"type":"string","description":"Border color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"shape":{"type":"string","description":"Object shape","enum":["0","1","2","3","4","5"]},"borderWidth":{"type":"string","description":"Border width","enum":["0px","1px","2px","3px","4px","5px","6px","7px"]},"filterType":{"type":"string","description":"Filter by type","enum":["type","api","role"]},"filterValue":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["description","text","background","border","shape","borderWidth","filterType","filterValue"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/themes/{themeId}":{"put":{"description":"Updates theme configuration for the specified theme ID. Only users with the Standard Registry role are allowed to make the request.","operationId":"ThemesApi_updateTheme","parameters":[{"name":"themeId","required":true,"in":"path","description":"Theme Identifier","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Object that contains a theme.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeDTO"}}}},"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"404":{"description":"Theme not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}},"422":{"description":"Invalid theme ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Updates theme configuration.","tags":["themes"]}}}}
```

## Deletes the theme.

> Deletes the theme with the provided theme ID. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"themes"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/themes/{themeId}":{"delete":{"description":"Deletes the theme with the provided theme ID. Only users with the Standard Registry role are allowed to make the request.","operationId":"ThemesApi_deleteTheme","parameters":[{"name":"themeId","required":true,"in":"path","description":"Theme Identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Invalid theme ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Deletes the theme.","tags":["themes"]}}}}
```

## Imports new theme from a zip file.

> Imports new theme from the provided zip file into the local DB. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"themes"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ThemeDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"createDate":{"type":"string","description":"Creation date in ISO 8601 format"},"updateDate":{"type":"string","description":"Last update date in ISO 8601 format"},"uuid":{"type":"string","description":"Unique universal identifier"},"owner":{"type":"string","description":"DID of the theme owner"},"name":{"type":"string","description":"Theme name"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/ThemeRoleDTO"}}},"required":["id","createDate","updateDate","uuid","owner","name","rules"]},"ThemeRoleDTO":{"type":"object","properties":{"description":{"type":"string"},"text":{"type":"string","description":"Text color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"background":{"type":"string","description":"Background color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"border":{"type":"string","description":"Border color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"shape":{"type":"string","description":"Object shape","enum":["0","1","2","3","4","5"]},"borderWidth":{"type":"string","description":"Border width","enum":["0px","1px","2px","3px","4px","5px","6px","7px"]},"filterType":{"type":"string","description":"Filter by type","enum":["type","api","role"]},"filterValue":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["description","text","background","border","shape","borderWidth","filterType","filterValue"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/themes/import/file":{"post":{"description":"Imports new theme from the provided zip file into the local DB. Only users with the Standard Registry role are allowed to make the request.","operationId":"ThemesApi_importTheme","parameters":[],"requestBody":{"required":true,"description":"A zip file containing theme to be imported.","content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Imports new theme from a zip file.","tags":["themes"]}}}}
```

## Returns a zip file containing the theme.

> Returns a zip file containing the theme. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"themes"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/themes/{themeId}/export/file":{"get":{"description":"Returns a zip file containing the theme. Only users with the Standard Registry role are allowed to make the request.","operationId":"ThemesApi_exportTheme","parameters":[{"name":"themeId","required":true,"in":"path","description":"Theme Identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation. Response zip file.","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unauthorized request.","content":{"application/zip":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/zip":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/zip":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Returns a zip file containing the theme.","tags":["themes"]}}}}
```