---
title: "Access Rights and Options API"
url: "https://earlyaccess.developers.bynder.com/apis/access-rights-and-options-api-1/versions/2cd9cb69-0956-4ff4-9774-4af770df8a45"
---

# Access Rights and Options API

OpenAPI specification document.

```json
{"components":{"schemas":{"ApiContentAccessMetapropertiesRequest":{"properties":{"level":{"$ref":"#/components/schemas/Level"},"principals":{"description":"","items":{"$ref":"#/components/schemas/Principal"},"type":"array"}},"title":"ApiContentAccessMetapropertiesRequest","type":"object"},"ApiContentAccessMetapropertiesRequest1":{"properties":{"contentAccessIds":{"description":"","items":{"type":"string"},"type":"array"}},"title":"ApiContentAccessMetapropertiesRequest1","type":"object"},"ApiContentAccessMetapropertiesResponse":{"properties":{"contentId":{"examples":["00000000-0000-0000-0000-000000000000"],"type":"string"},"contentType":{"examples":["metaproperty"],"type":"string"},"id":{"examples":["00000000-0000-0000-0000-000000000000"],"type":"string"},"level":{"examples":["metaproperty.hide"],"type":"string"},"principalExtraInformation":{"$ref":"#/components/schemas/PrincipalExtraInformation"},"principalId":{"examples":["00000000-0000-0000-0000-000000000000"],"type":"string"},"principalName":{"examples":["User full name"],"type":"string"},"principalType":{"examples":["user"],"type":"string"},"ruleType":{"examples":["allow"],"type":"string"}},"title":"ApiContentAccessMetapropertiesResponse","type":"object"},"ApiContentAccessMetapropertiesResponse1":{"properties":{"principalId":{"examples":["00000000-0000-0000-0000-000000000000"],"type":"string"},"principalType":{"examples":["user"],"type":"string"}},"title":"ApiContentAccessMetapropertiesResponse1","type":"object"},"Level":{"const":"metaproperty.hide","examples":["metaproperty.hide"],"title":"Level","type":"string"},"Principal":{"properties":{"principalId":{"examples":["00000000-0000-0000-0000000000000000"],"type":"string"},"principalType":{"$ref":"#/components/schemas/PrincipalType"}},"title":"Principal","type":"object"},"PrincipalExtraInformation":{"properties":{"email":{"examples":["user_email@bynder.com"],"type":"string"}},"title":"PrincipalExtraInformation","type":"object"},"PrincipalType":{"enum":["user","group","profile"],"examples":["user"],"title":"PrincipalType","type":"string"}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://DefaultParameterValue/","scopes":{},"tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{},"tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"contact":{},"title":"Access Rights and Options API","version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","openapi":"3.1.0","paths":{"/api/1/content-access/options/{optionId}":{"get":{"parameters":[{"description":"Option ID","in":"path","name":"optionId","required":true,"schema":{"type":"string"}},{"description":"Principal ID","in":"query","name":"principalId","required":false,"schema":{"type":"string"}},{"description":"Number of results to return","in":"query","name":"limit","required":false,"schema":{"default":20,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Cursor for next page","in":"query","name":"start","required":false,"schema":{"type":"string"}},{"description":"Cursor for previous page","in":"query","name":"before","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ApiContentAccessMetapropertiesResponse"},"type":"array"}}},"description":"Successful response"},"403":{"description":"Forbidden"}},"summary":"Retrieve Option Access Rights","tags":["Options"]},"put":{"parameters":[{"description":"Option ID","in":"path","name":"optionId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiContentAccessMetapropertiesRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ApiContentAccessMetapropertiesResponse1"},"type":"array"}}},"description":"Successful response"},"403":{"description":"Forbidden"}},"summary":"Modify Option Access Rights","tags":["Options"]}},"/api/1/content-access/options/{optionId}/visibility":{"get":{"parameters":[{"description":"Option ID","in":"path","name":"optionId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"defaultVisibility":{"type":"boolean"}},"type":"object"}}},"description":"Successful response"},"403":{"description":"Forbidden"}},"summary":"Retrieve Option Default Visibility","tags":["Options"]},"put":{"parameters":[{"description":"Option ID","in":"path","name":"optionId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"defaultVisibility":{"type":"boolean"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"defaultVisibility":{"type":"boolean"}},"type":"object"}}},"description":"Successful response"},"403":{"description":"Forbidden"}},"summary":"Modify Option Default Visibility","tags":["Options"]}},"/api/content_access/metaproperties/{metaproperty_id}":{"delete":{"deprecated":false,"description":"","operationId":"Delete metaproperty access","parameters":[{"description":"Metaproperty id.","in":"path","name":"metaproperty_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiContentAccessMetapropertiesRequest1"}}},"description":"","required":true},"responses":{"204":{"content":{},"description":"Metaproperty access deleted","headers":{}}},"summary":"Delete metaproperty access","tags":["Access rights"]},"get":{"deprecated":false,"description":"","operationId":"Retrieve metaproperty access","parameters":[{"description":"Metaproperty id.","in":"path","name":"metaproperty_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"contentMediaType":"application/json","description":"","items":{"$ref":"#/components/schemas/ApiContentAccessMetapropertiesResponse"},"type":"array"}}},"description":"Successful retrieval of metaproperty access","headers":{}}},"summary":"Retrieve metaproperty access","tags":["Access rights"]},"parameters":[],"post":{"deprecated":false,"description":"","operationId":"Create metaproperty access","parameters":[{"description":"Metaproperty id.","in":"path","name":"metaproperty_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiContentAccessMetapropertiesRequest"}}},"description":"","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"contentMediaType":"application/json","description":"","items":{"$ref":"#/components/schemas/ApiContentAccessMetapropertiesResponse1"},"type":"array"}}},"description":"Metaproperty access created","headers":{}}},"summary":"Create metaproperty access","tags":["Access rights"]}}},"security":[{"OAuth2":[]},{"permanentToken":[]}],"servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}}],"tags":[{"description":"","name":"Access rights"},{"description":"","name":"Options"}]}
```