Bynder Access Rights and Optiops API

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