{"items":[{"type":"link","label":"Admin API Reference","link":"/zephr-api-reference/zephr-admin-api","routeSlug":"/zephr-api-reference/zephr-admin-api","content":{"contentType":"overview","meta":{"name":"Admin API Reference"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"zephr-admin-api.json","url":"/_bundle/zephr-api-reference/zephr-admin-api.json?download"},{"kind":"download","label":"zephr-admin-api.yaml","url":"/_bundle/zephr-api-reference/zephr-admin-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"cURL","lang":"curl"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo","description":"Your tenant ID."}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Admin API Reference (2026-09-18)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Zephr Admin API provides RESTful access to all Zephr functionality. It is designed for server-side integrations. All requests must be signed as described in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair","target":"__blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HMAC Request Signing and Key Pairs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Admin API uses a base URL with the following format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{tenantId}.api.zephr.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you have multiple tenants, the current tenant ID is shown in a blue box in the top right of the Admin Console.  If you have a single site, you can find the tenant ID by navigating to your site domains. To do this, select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sites"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" menu, select your site, and then click the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Site Domains"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button. The tenant ID is the first part of the domain. For example, if the domain is "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"news-paper.cdn.zephr.com"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the tenant ID is "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"news"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/zephr-api-reference/zephr-admin-api"}],"sectionId":"/zephr-api-reference/zephr-admin-api"}]}]}},{"type":"group","label":"Account User","link":"/zephr-api-reference/zephr-admin-api/account-user","routeSlug":"/zephr-api-reference/zephr-admin-api/account-user","items":[{"label":"List account users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account-user/listaccountusers","routeSlug":"/zephr-api-reference/zephr-admin-api/account-user/listaccountusers","metadata":{"seo":{"title":"List account users","description":"Retrieves all the account users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAccountUsers","name":"List account users","isWebhook":false,"pointer":"/paths/~1v3~1accounts~1{account_id}~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List account users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all the account users."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_0","description":"Unique Account identifier.","required":true}],"pointer":"/paths/~1v3~1accounts~1{account_id}~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/accounts/{account_id}/users","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/accounts/{account_id}/users","href":"account-user/listaccountusers","openApiOperationId":"listAccountUsers","summary":"List account users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/account-user","exampleIds":["paths/~1v3~1accounts~1{account_id}~1users/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/account-user","exampleIds":["paths/~1v3~1accounts~1{account_id}~1users/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1accounts~1{account_id}~1users/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/account-user","exampleIds":["paths/~1v3~1accounts~1{account_id}~1users/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/account-user","exampleIds":["paths/~1v3~1accounts~1{account_id}~1users/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-user/listaccountusers"}],"panels":[]}]},"httpPath":"/v3/accounts/{account_id}/users"},{"label":"Retrieve an account user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account-user/retrieveaccountuser","routeSlug":"/zephr-api-reference/zephr-admin-api/account-user/retrieveaccountuser","metadata":{"seo":{"title":"Retrieve an account user","description":"Retrieves an account user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveAccountUser","name":"Retrieve an account user","isWebhook":false,"pointer":"/paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an account user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an account user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_0","description":"Unique Account identifier","required":true},{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/accounts/{account_id}/users/{user_id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_0"},{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/accounts/{account_id}/users/{user_id}","href":"account-user/retrieveaccountuser","openApiOperationId":"retrieveAccountUser","summary":"Retrieve an account user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/account-user","exampleIds":["paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/account-user","exampleIds":["paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/account-user","exampleIds":["paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/account-user","exampleIds":["paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-user/retrieveaccountuser"}],"panels":[]}]},"httpPath":"/v3/accounts/{account_id}/users/{user_id}"},{"label":"Delete an account user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account-user/deleteaccountuser","routeSlug":"/zephr-api-reference/zephr-admin-api/account-user/deleteaccountuser","metadata":{"seo":{"title":"Delete an account user","description":"Deletes an account user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAccountUser","name":"Delete an account user","isWebhook":false,"pointer":"/paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an account user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an account user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_0","description":"Unique Account identifier","required":true},{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/accounts/{account_id}/users/{user_id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_0"},{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/accounts/{account_id}/users/{user_id}","href":"account-user/deleteaccountuser","openApiOperationId":"deleteAccountUser","summary":"Delete an account user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-user/deleteaccountuser"}],"panels":[]}]},"httpPath":"/v3/accounts/{account_id}/users/{user_id}"},{"label":"Save or Create an account user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account-user/saveaccountuser","routeSlug":"/zephr-api-reference/zephr-admin-api/account-user/saveaccountuser","metadata":{"seo":{"title":"Save or Create an account user","description":"Saves or Creates an account specified by account_id and user_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"saveAccountUser","name":"Save or Create an account user","isWebhook":false,"pointer":"/paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Save or Create an account user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saves or Creates an account specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_0","description":"Unique Account identifier","required":true,"example":"5fag4a2d-86cd-4bb0-a5df-68dca75a3a21"},{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true,"example":"3f589a2d-86ad-4b70-a5df-68dca75a3a21"}],"pointer":"/paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/accounts/{account_id}/users/{user_id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"example":"5fag4a2d-86cd-4bb0-a5df-68dca75a3a21","schemaId":"schema_0"},{"name":"user_id","in":"path","required":true,"example":"3f589a2d-86ad-4b70-a5df-68dca75a3a21","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","201","400"],"pointer":"/v3/accounts/{account_id}/users/{user_id}","href":"account-user/saveaccountuser","openApiOperationId":"saveAccountUser","summary":"Save or Create an account user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - User was successfully inserted or updated.","headers":{}},{"code":"201","description":"Created - The request has been fulfilled and user was inserted or updated","headers":{}},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request - Cannot find an existing user for the supplied "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_id"},"children":[]}]}]}],"headers":{}}],"pointer":"/paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-user/saveaccountuser"}],"panels":[]}]},"httpPath":"/v3/accounts/{account_id}/users/{user_id}"},{"label":"List account users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account-user/listaccountusersv4","routeSlug":"/zephr-api-reference/zephr-admin-api/account-user/listaccountusersv4","metadata":{"seo":{"title":"List account users","description":"Retrieves all the account users, if the accountId has users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAccountUsersV4","name":"List account users","isWebhook":false,"pointer":"/paths/~1v4~1accounts~1{accountId}~1grants/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List account users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves all the account users, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has users."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_0","description":"Unique Account identifier","required":true,"example":"5fag4a2d-86cd-4bb0-a5df-68dca75a3a21"}],"pointer":"/paths/~1v4~1accounts~1{accountId}~1grants/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/accounts/{accountId}/grants","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"example":"5fag4a2d-86cd-4bb0-a5df-68dca75a3a21","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/accounts/{accountId}/grants","href":"account-user/listaccountusersv4","openApiOperationId":"listAccountUsersV4","summary":"List account users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK - Users were found for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1","exampleIds":["paths/~1v4~1accounts~1{accountId}~1grants/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_1","exampleIds":["paths/~1v4~1accounts~1{accountId}~1grants/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found - Cannot find users with the supplied "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]}]}]}],"headers":{}}],"pointer":"/paths/~1v4~1accounts~1{accountId}~1grants/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1","exampleIds":["paths/~1v4~1accounts~1{accountId}~1grants/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1","exampleIds":["paths/~1v4~1accounts~1{accountId}~1grants/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-user/listaccountusersv4"}],"panels":[]}]},"httpPath":"/v4/accounts/{accountId}/grants"}],"content":{"contentType":"group","meta":{"name":"Account User"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account User","showPageActions":true},{"nodeType":"markdoc","content":"Contains operations on the Account User resource."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/accounts/{account_id}/users","summary":"List account users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-user/listaccountusers","deprecated":false},{"title":"/v3/accounts/{account_id}/users/{user_id}","summary":"Retrieve an account user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-user/retrieveaccountuser","deprecated":false},{"title":"/v3/accounts/{account_id}/users/{user_id}","summary":"Delete an account user","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account-user/deleteaccountuser","deprecated":false},{"title":"/v3/accounts/{account_id}/users/{user_id}","summary":"Save or Create an account user","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-user/saveaccountuser","deprecated":false},{"title":"/v4/accounts/{accountId}/grants","summary":"List account users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-user/listaccountusersv4","deprecated":false}]}]}]}]}},{"type":"group","label":"Admin User","link":"/zephr-api-reference/zephr-admin-api/admin-user","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user","items":[{"label":"Create an admin user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/createadminuser","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/createadminuser","metadata":{"seo":{"title":"Create an admin user","description":"Creates a new admin user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAdminUser","name":"Create an admin user","isWebhook":false,"pointer":"/paths/~1v3~1admin~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an admin user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new admin user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","pointer":"/paths/~1v3~1admin~1users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/admin/users","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_2"}},"responseCodes":["201","400"],"pointer":"/v3/admin/users","href":"admin-user/createadminuser","openApiOperationId":"createAdminUser","summary":"Create an admin user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-user-response","exampleIds":["paths/~1v3~1admin~1users/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/admin-user-response","exampleIds":["paths/~1v3~1admin~1users/post/responses/201/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1admin~1users/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/admin-user-response","exampleIds":["paths/~1v3~1admin~1users/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-user-response","exampleIds":["paths/~1v3~1admin~1users/post/responses/201/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-user/createadminuser"}],"panels":[]}]},"httpPath":"/v3/admin/users"},{"label":"Log in to an admin user account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/loginadminuseraccount","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/loginadminuseraccount","metadata":{"seo":{"title":"Log in to an admin user account","description":"Logs in to an admin user account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"logInAdminUserAccount","name":"Log in to an admin user account","isWebhook":false,"pointer":"/paths/~1v3~1admin~1login/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Log in to an admin user account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Logs in to an admin user account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_3"}},"schemaId":"schema_3","pointer":"/paths/~1v3~1admin~1login/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/admin/login","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_3"}},"responseCodes":["200","400","401"],"pointer":"/v3/admin/login","href":"admin-user/loginadminuseraccount","openApiOperationId":"logInAdminUserAccount","summary":"Log in to an admin user account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_3","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_3"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-user-login-response","exampleIds":["paths/~1v3~1admin~1login/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/admin-user-login-response","exampleIds":["paths/~1v3~1admin~1login/post/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request","headers":{}},{"code":"401","description":"Unauthorized","headers":{}}],"pointer":"/paths/~1v3~1admin~1login/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/admin-user-login-response","exampleIds":["paths/~1v3~1admin~1login/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-user-login-response","exampleIds":["paths/~1v3~1admin~1login/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-user/loginadminuseraccount"}],"panels":[]}]},"httpPath":"/v3/admin/login"},{"label":"Log out of the admin user account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/logoutadminuseraccount","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/logoutadminuseraccount","metadata":{"seo":{"title":"Log out of the admin user account","description":"Logs out of the admin user account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"logOutAdminUserAccount","name":"Log out of the admin user account","isWebhook":false,"pointer":"/paths/~1v3~1admin~1logout/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Log out of the admin user account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Logs out of the admin user account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"blaize-admin-session","in":"header","schemaId":"schema_0","description":"e.g. (string)","example":"(string)"}],"pointer":"/paths/~1v3~1admin~1logout/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/admin/logout","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"blaize-admin-session","in":"header","required":false,"example":"(string)","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/admin/logout","href":"admin-user/logoutadminuseraccount","openApiOperationId":"logOutAdminUserAccount","summary":"Log out of the admin user account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/logout-response","exampleIds":["paths/~1v3~1admin~1logout/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/logout-response","exampleIds":["paths/~1v3~1admin~1logout/post/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1admin~1logout/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/logout-response","exampleIds":["paths/~1v3~1admin~1logout/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/logout-response","exampleIds":["paths/~1v3~1admin~1logout/post/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-user/logoutadminuseraccount"}],"panels":[]}]},"httpPath":"/v3/admin/logout"},{"label":"Issue a key pair","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/issuekeypair","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/issuekeypair","metadata":{"seo":{"title":"Issue a key pair","description":"Issues a new key pair for the admin user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"issueKeyPair","name":"Issue a key pair","isWebhook":false,"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1keypairs/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue a key pair","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Issues a new key pair for the admin user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User Identifier","required":true}],"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1keypairs/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/admin/users/{user_id}/keypairs","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["201","404"],"pointer":"/v3/admin/users/{user_id}/keypairs","href":"admin-user/issuekeypair","openApiOperationId":"issueKeyPair","summary":"Issue a key pair"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/issue-keypair-response","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1keypairs/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/issue-keypair-response","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1keypairs/post/responses/201/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1keypairs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/issue-keypair-response","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1keypairs/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/issue-keypair-response","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1keypairs/post/responses/201/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-user/issuekeypair"}],"panels":[]}]},"httpPath":"/v3/admin/users/{user_id}/keypairs"},{"label":"List access keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/listaccesskeys","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/listaccesskeys","metadata":{"seo":{"title":"List access keys","description":"Retrieves a list of access keys for the admin user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAccessKeys","name":"List access keys","isWebhook":false,"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1keypairs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List access keys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of access keys for the admin user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User Identifier","required":true}],"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1keypairs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/admin/users/{user_id}/keypairs","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/admin/users/{user_id}/keypairs","href":"admin-user/listaccesskeys","openApiOperationId":"listAccessKeys","summary":"List access keys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/get-access-key-response","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1keypairs/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/get-access-key-response","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1keypairs/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1keypairs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/get-access-key-response","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1keypairs/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/get-access-key-response","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1keypairs/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-user/listaccesskeys"}],"panels":[]}]},"httpPath":"/v3/admin/users/{user_id}/keypairs"},{"label":"Revoke a keypair","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/revokekeypair","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/revokekeypair","metadata":{"seo":{"title":"Revoke a keypair","description":"Revokes a keypair."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"revokeKeypair","name":"Revoke a keypair","isWebhook":false,"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1keypairs~1{access_key}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke a keypair","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revokes a keypair."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true},{"name":"access_key","in":"path","schemaId":"schema_0","description":"Access Key identifier","required":true}],"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1keypairs~1{access_key}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/admin/users/{user_id}/keypairs/{access_key}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"},{"name":"access_key","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/admin/users/{user_id}/keypairs/{access_key}","href":"admin-user/revokekeypair","openApiOperationId":"revokeKeypair","summary":"Revoke a keypair"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/revoke-keypair-response","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1keypairs~1{access_key}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/revoke-keypair-response","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1keypairs~1{access_key}/delete/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1keypairs~1{access_key}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/revoke-keypair-response","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1keypairs~1{access_key}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/revoke-keypair-response","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1keypairs~1{access_key}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-user/revokekeypair"}],"panels":[]}]},"httpPath":"/v3/admin/users/{user_id}/keypairs/{access_key}"},{"label":"List user roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/listuserroles","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/listuserroles","metadata":{"seo":{"title":"List user roles","description":"Retrieves the user roles an admin user is assigned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserRoles","name":"List user roles","isWebhook":false,"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the user roles an admin user is assigned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/admin/users/{user_id}/roles","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/admin/users/{user_id}/roles","href":"admin-user/listuserroles","openApiOperationId":"listUserRoles","summary":"List user roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-roles","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1roles/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/admin-roles","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1roles/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/admin-roles","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1roles/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-roles","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1roles/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-user/listuserroles"}],"panels":[]}]},"httpPath":"/v3/admin/users/{user_id}/roles"},{"label":"List user roles by tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/listusertenantroles","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/listusertenantroles","metadata":{"seo":{"title":"List user roles by tenant","description":"Retrieves the admin user's roles by tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserTenantRoles","name":"List user roles by tenant","isWebhook":false,"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1roles~1{tenant}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user roles by tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the admin user's roles by tenant."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true},{"name":"tenant","in":"path","schemaId":"schema_0","description":"Tenant identifier","required":true}],"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1roles~1{tenant}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/admin/users/{user_id}/roles/{tenant}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/admin/users/{user_id}/roles/{tenant}","href":"admin-user/listusertenantroles","openApiOperationId":"listUserTenantRoles","summary":"List user roles by tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-roles","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1roles~1{tenant}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/admin-roles","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1roles~1{tenant}/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1admin~1users~1{user_id}~1roles~1{tenant}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/admin-roles","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1roles~1{tenant}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-roles","exampleIds":["paths/~1v3~1admin~1users~1{user_id}~1roles~1{tenant}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-user/listusertenantroles"}],"panels":[]}]},"httpPath":"/v3/admin/users/{user_id}/roles/{tenant}"},{"label":"Create admin user roles","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/createadminrole","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/createadminrole","metadata":{"seo":{"title":"Create admin user roles","description":"Creates admin user roles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAdminRole","name":"Create admin user roles","isWebhook":false,"pointer":"/paths/~1v3~1admin~1roles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create admin user roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates admin user roles."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_4"}},"schemaId":"schema_4","pointer":"/paths/~1v3~1admin~1roles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/admin/roles","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_4"}},"responseCodes":["201","400"],"pointer":"/v3/admin/roles","href":"admin-user/createadminrole","openApiOperationId":"createAdminRole","summary":"Create admin user roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_4","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_4"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-role-creation-response","exampleIds":["paths/~1v3~1admin~1roles/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/admin-role-creation-response","exampleIds":["paths/~1v3~1admin~1roles/post/responses/201/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1admin~1roles/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/admin-role-creation-response","exampleIds":["paths/~1v3~1admin~1roles/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-role-creation-response","exampleIds":["paths/~1v3~1admin~1roles/post/responses/201/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-user/createadminrole"}],"panels":[]}]},"httpPath":"/v3/admin/roles"},{"label":"List admin user roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/listroles","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/listroles","metadata":{"seo":{"title":"List admin user roles","description":"Retrieves the admin user roles by tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRoles","name":"List admin user roles","isWebhook":false,"pointer":"/paths/~1v3~1admin~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List admin user roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the admin user roles by tenant."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/admin/roles","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/admin/roles","href":"admin-user/listroles","openApiOperationId":"listRoles","summary":"List admin user roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-admin-roles-response","exampleIds":["paths/~1v3~1admin~1roles/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/list-admin-roles-response","exampleIds":["paths/~1v3~1admin~1roles/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1admin~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/list-admin-roles-response","exampleIds":["paths/~1v3~1admin~1roles/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-admin-roles-response","exampleIds":["paths/~1v3~1admin~1roles/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-user/listroles"}],"panels":[]}]},"httpPath":"/v3/admin/roles"},{"label":"Update an admin user role","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/updaterole","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/updaterole","metadata":{"seo":{"title":"Update an admin user role","description":"Updates an admin user role by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRole","name":"Update an admin user role","isWebhook":false,"pointer":"/paths/~1v3~1admin~1roles~1{role_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an admin user role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an admin user role by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"role_id","in":"path","schemaId":"schema_0","description":"Unique Role identifier","required":true}],"pointer":"/paths/~1v3~1admin~1roles~1{role_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_4"}},"schemaId":"schema_4","pointer":"/paths/~1v3~1admin~1roles~1{role_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/admin/roles/{role_id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"role_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_4"}},"responseCodes":["200","400"],"pointer":"/v3/admin/roles/{role_id}","href":"admin-user/updaterole","openApiOperationId":"updateRole","summary":"Update an admin user role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_4","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_4"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-role-update-response","exampleIds":["paths/~1v3~1admin~1roles~1{role_id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/admin-role-update-response","exampleIds":["paths/~1v3~1admin~1roles~1{role_id}/put/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1admin~1roles~1{role_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/admin-role-update-response","exampleIds":["paths/~1v3~1admin~1roles~1{role_id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-role-update-response","exampleIds":["paths/~1v3~1admin~1roles~1{role_id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-user/updaterole"}],"panels":[]}]},"httpPath":"/v3/admin/roles/{role_id}"},{"label":"Retrieve an admin user role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/getrole","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/getrole","metadata":{"seo":{"title":"Retrieve an admin user role","description":"Retrieves an admin user role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRole","name":"Retrieve an admin user role","isWebhook":false,"pointer":"/paths/~1v3~1admin~1roles~1{role_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an admin user role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an admin user role."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"role_id","in":"path","schemaId":"schema_0","description":"Unique Role identifier","required":true}],"pointer":"/paths/~1v3~1admin~1roles~1{role_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/admin/roles/{role_id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"role_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/admin/roles/{role_id}","href":"admin-user/getrole","openApiOperationId":"getRole","summary":"Retrieve an admin user role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-admin-role-response","exampleIds":["paths/~1v3~1admin~1roles~1{role_id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/list-admin-role-response","exampleIds":["paths/~1v3~1admin~1roles~1{role_id}/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1admin~1roles~1{role_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/list-admin-role-response","exampleIds":["paths/~1v3~1admin~1roles~1{role_id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-admin-role-response","exampleIds":["paths/~1v3~1admin~1roles~1{role_id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-user/getrole"}],"panels":[]}]},"httpPath":"/v3/admin/roles/{role_id}"},{"label":"Delete an admin user role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/deleterole","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/deleterole","metadata":{"seo":{"title":"Delete an admin user role","description":"Deletes an admin user role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRole","name":"Delete an admin user role","isWebhook":false,"pointer":"/paths/~1v3~1admin~1roles~1{role_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an admin user role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an admin user role."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"role_id","in":"path","schemaId":"schema_0","description":"Unique Role identifier","required":true}],"pointer":"/paths/~1v3~1admin~1roles~1{role_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/admin/roles/{role_id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"role_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/admin/roles/{role_id}","href":"admin-user/deleterole","openApiOperationId":"deleteRole","summary":"Delete an admin user role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-role-deleted-response","exampleIds":["paths/~1v3~1admin~1roles~1{role_id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/admin-role-deleted-response","exampleIds":["paths/~1v3~1admin~1roles~1{role_id}/delete/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1admin~1roles~1{role_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/admin-role-deleted-response","exampleIds":["paths/~1v3~1admin~1roles~1{role_id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-role-deleted-response","exampleIds":["paths/~1v3~1admin~1roles~1{role_id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-user/deleterole"}],"panels":[]}]},"httpPath":"/v3/admin/roles/{role_id}"},{"label":"Retrieve an admin user by session ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/admin-user/getsessionuser","routeSlug":"/zephr-api-reference/zephr-admin-api/admin-user/getsessionuser","metadata":{"seo":{"title":"Retrieve an admin user by session ID","description":"Retrieves an admin user by session ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSessionUser","name":"Retrieve an admin user by session ID","isWebhook":false,"pointer":"/paths/~1v3~1admin~1sessions~1{blaize_admin_session_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an admin user by session ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an admin user by session ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"blaize_admin_session_id","in":"path","schemaId":"schema_0","description":"Admin User Session identifier","required":true}],"pointer":"/paths/~1v3~1admin~1sessions~1{blaize_admin_session_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/admin/sessions/{blaize_admin_session_id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"blaize_admin_session_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/admin/sessions/{blaize_admin_session_id}","href":"admin-user/getsessionuser","openApiOperationId":"getSessionUser","summary":"Retrieve an admin user by session ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user_identifier","exampleIds":["paths/~1v3~1admin~1sessions~1{blaize_admin_session_id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/user_identifier","exampleIds":["paths/~1v3~1admin~1sessions~1{blaize_admin_session_id}/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1admin~1sessions~1{blaize_admin_session_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/user_identifier","exampleIds":["paths/~1v3~1admin~1sessions~1{blaize_admin_session_id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user_identifier","exampleIds":["paths/~1v3~1admin~1sessions~1{blaize_admin_session_id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin-user/getsessionuser"}],"panels":[]}]},"httpPath":"/v3/admin/sessions/{blaize_admin_session_id}"}],"content":{"contentType":"group","meta":{"name":"Admin User"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Admin User","showPageActions":true},{"nodeType":"markdoc","content":"Contains operations on the Admin User resource."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/admin/users","summary":"Create an admin user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/admin-user/createadminuser","deprecated":false},{"title":"/v3/admin/login","summary":"Log in to an admin user account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/admin-user/loginadminuseraccount","deprecated":false},{"title":"/v3/admin/logout","summary":"Log out of the admin user account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/admin-user/logoutadminuseraccount","deprecated":false},{"title":"/v3/admin/users/{user_id}/keypairs","summary":"Issue a key pair","prefix":{"name":"post","color":"post"},"badges":[],"link":"/admin-user/issuekeypair","deprecated":false},{"title":"/v3/admin/users/{user_id}/keypairs","summary":"List access keys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admin-user/listaccesskeys","deprecated":false},{"title":"/v3/admin/users/{user_id}/keypairs/{access_key}","summary":"Revoke a keypair","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/admin-user/revokekeypair","deprecated":false},{"title":"/v3/admin/users/{user_id}/roles","summary":"List user roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admin-user/listuserroles","deprecated":false},{"title":"/v3/admin/users/{user_id}/roles/{tenant}","summary":"List user roles by tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admin-user/listusertenantroles","deprecated":false},{"title":"/v3/admin/roles","summary":"Create admin user roles","prefix":{"name":"post","color":"post"},"badges":[],"link":"/admin-user/createadminrole","deprecated":false},{"title":"/v3/admin/roles","summary":"List admin user roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admin-user/listroles","deprecated":false},{"title":"/v3/admin/roles/{role_id}","summary":"Update an admin user role","prefix":{"name":"put","color":"put"},"badges":[],"link":"/admin-user/updaterole","deprecated":false},{"title":"/v3/admin/roles/{role_id}","summary":"Retrieve an admin user role","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admin-user/getrole","deprecated":false},{"title":"/v3/admin/roles/{role_id}","summary":"Delete an admin user role","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/admin-user/deleterole","deprecated":false},{"title":"/v3/admin/sessions/{blaize_admin_session_id}","summary":"Retrieve an admin user by session ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admin-user/getsessionuser","deprecated":false}]}]}]}]}},{"type":"group","label":"Bundle","link":"/zephr-api-reference/zephr-admin-api/bundle","routeSlug":"/zephr-api-reference/zephr-admin-api/bundle","items":[{"label":"List Bundles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/bundle/listbundles","routeSlug":"/zephr-api-reference/zephr-admin-api/bundle/listbundles","metadata":{"seo":{"title":"List Bundles","description":"Retrieves a list of bundles wrapped in the element \"results\". Each bundle contains a list of entitlements, meters, credits, and other bundles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBundles","name":"List Bundles","isWebhook":false,"pointer":"/paths/~1v3~1bundles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Bundles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of bundles wrapped in the element \"results\". Each bundle contains a list of entitlements, meters, credits, and other bundles."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/bundles","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/bundles","href":"bundle/listbundles","openApiOperationId":"listBundles","summary":"List Bundles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bundles"}},"schemaId":"components/schemas/bundles","headers":{}},{"code":"401","description":"Unauthorized. Returned if no valid authentication was provided.","headers":{}}],"pointer":"/paths/~1v3~1bundles/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/bundles","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bundles"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bundle/listbundles"}],"panels":[]}]},"httpPath":"/v3/bundles"},{"label":"Create Bundles","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/bundle/createbundles","routeSlug":"/zephr-api-reference/zephr-admin-api/bundle/createbundles","metadata":{"seo":{"title":"Create Bundles","description":"Creates Bundles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBundles","name":"Create Bundles","isWebhook":false,"pointer":"/paths/~1v3~1bundles/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Bundles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates Bundles."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","pointer":"/paths/~1v3~1bundles/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/bundles","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5"}},"responseCodes":["201","400"],"pointer":"/v3/bundles","href":"bundle/createbundles","openApiOperationId":"createBundles","summary":"Create Bundles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1bundles/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bundle/createbundles"}],"panels":[]}]},"httpPath":"/v3/bundles"},{"label":"Create a Bundle","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/bundle/createbundle","routeSlug":"/zephr-api-reference/zephr-admin-api/bundle/createbundle","metadata":{"seo":{"title":"Create a Bundle","description":"Creates a Bundle."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBundle","name":"Create a Bundle","isWebhook":false,"pointer":"/paths/~1v3~1bundles~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Bundle","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a Bundle."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Bundle identifier","required":true}],"pointer":"/paths/~1v3~1bundles~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","pointer":"/paths/~1v3~1bundles~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/bundles/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5"}},"responseCodes":["201","400"],"pointer":"/v3/bundles/{id}","href":"bundle/createbundle","openApiOperationId":"createBundle","summary":"Create a Bundle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1bundles~1{id}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bundle/createbundle"}],"panels":[]}]},"httpPath":"/v3/bundles/{id}"},{"label":"Retrieve a Bundle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/bundle/getbundle","routeSlug":"/zephr-api-reference/zephr-admin-api/bundle/getbundle","metadata":{"seo":{"title":"Retrieve a Bundle","description":"Retrieves a single bundle. Each bundle contains a list of entitlements, meters, credits, and other bundles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBundle","name":"Retrieve a Bundle","isWebhook":false,"pointer":"/paths/~1v3~1bundles~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Bundle","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single bundle. Each bundle contains a list of entitlements, meters, credits, and other bundles."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Bundle Identifier.","required":true}],"pointer":"/paths/~1v3~1bundles~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/bundles/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/bundles/{id}","href":"bundle/getbundle","openApiOperationId":"getBundle","summary":"Retrieve a Bundle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bundle"}},"schemaId":"components/schemas/bundle","headers":{}},{"code":"401","description":"Unauthorized. Returned if no valid authentication was provided.","headers":{}},{"code":"404","description":"Not Found. Returned if the ID is invalid. No bundle found.","headers":{}}],"pointer":"/paths/~1v3~1bundles~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/bundle","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bundle"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bundle/getbundle"}],"panels":[]}]},"httpPath":"/v3/bundles/{id}"},{"label":"Delete Bundle","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/bundle/deletebundle","routeSlug":"/zephr-api-reference/zephr-admin-api/bundle/deletebundle","metadata":{"seo":{"title":"Delete Bundle","description":"Deletes a Bundle."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBundle","name":"Delete Bundle","isWebhook":false,"pointer":"/paths/~1v3~1bundles~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Bundle","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a Bundle."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Bundle Identifier.","required":true}],"pointer":"/paths/~1v3~1bundles~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/bundles/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/bundles/{id}","href":"bundle/deletebundle","openApiOperationId":"deleteBundle","summary":"Delete Bundle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. Returned if the bundle was successfully deleted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1v3~1bundles~1{id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_6","exampleIds":["paths/~1v3~1bundles~1{id}/delete/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"401","description":"Unauthorized. Returned if no valid authentication was provided.","headers":{}},{"code":"404","description":"Not Found. Returned if the ID is invalid. No bundle found.","headers":{}}],"pointer":"/paths/~1v3~1bundles~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_6","exampleIds":["paths/~1v3~1bundles~1{id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1v3~1bundles~1{id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bundle/deletebundle"}],"panels":[]}]},"httpPath":"/v3/bundles/{id}"}],"content":{"contentType":"group","meta":{"name":"Bundle"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bundle","showPageActions":true},{"nodeType":"markdoc","content":"Contains operations on the Bundle resource."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/bundles","summary":"List Bundles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bundle/listbundles","deprecated":false},{"title":"/v3/bundles","summary":"Create Bundles","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bundle/createbundles","deprecated":false},{"title":"/v3/bundles/{id}","summary":"Create a Bundle","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bundle/createbundle","deprecated":false},{"title":"/v3/bundles/{id}","summary":"Retrieve a Bundle","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bundle/getbundle","deprecated":false},{"title":"/v3/bundles/{id}","summary":"Delete Bundle","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bundle/deletebundle","deprecated":false}]}]}]}]}},{"type":"group","label":"Cache Configurations","link":"/zephr-api-reference/zephr-admin-api/cache-configurations","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-configurations","items":[{"label":"List cache configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-configurations/listcacheconfigurations","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-configurations/listcacheconfigurations","metadata":{"seo":{"title":"List cache configurations","description":"Retrieves a list of cache configurations wrapped in the element \"results\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCacheConfigurations","name":"List cache configurations","isWebhook":false,"pointer":"/paths/~1v3~1cache-configurations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List cache configurations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of cache configurations wrapped in the element \"results\"."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/cache-configurations","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/cache-configurations","href":"cache-configurations/listcacheconfigurations","openApiOperationId":"listCacheConfigurations","summary":"List cache configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cache_configurations_objects","exampleIds":["paths/~1v3~1cache-configurations/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/cache_configurations_objects","exampleIds":["paths/~1v3~1cache-configurations/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1cache-configurations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/cache_configurations_objects","exampleIds":["paths/~1v3~1cache-configurations/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cache_configurations_objects","exampleIds":["paths/~1v3~1cache-configurations/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cache-configurations/listcacheconfigurations"}],"panels":[]}]},"httpPath":"/v3/cache-configurations"},{"label":"Create a cache configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-configurations/createcacheconfiguration","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-configurations/createcacheconfiguration","metadata":{"seo":{"title":"Create a cache configuration","description":"Creates a Cache Configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCacheConfiguration","name":"Create a cache configuration","isWebhook":false,"pointer":"/paths/~1v3~1cache-configurations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a cache configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a Cache Configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7","pointer":"/paths/~1v3~1cache-configurations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/cache-configurations","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7"}},"responseCodes":["201","400"],"pointer":"/v3/cache-configurations","href":"cache-configurations/createcacheconfiguration","openApiOperationId":"createCacheConfiguration","summary":"Create a cache configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1cache-configurations/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cache-configurations/createcacheconfiguration"}],"panels":[]}]},"httpPath":"/v3/cache-configurations"},{"label":"Retrieve a cache configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-configurations/getcacheconfiguration","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-configurations/getcacheconfiguration","metadata":{"seo":{"title":"Retrieve a cache configuration","description":"Retrieves a single cache configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCacheConfiguration","name":"Retrieve a cache configuration","isWebhook":false,"pointer":"/paths/~1v3~1cache-configurations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a cache configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single cache configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Cache Configuration identifier","required":true}],"pointer":"/paths/~1v3~1cache-configurations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/cache-configurations/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/cache-configurations/{id}","href":"cache-configurations/getcacheconfiguration","openApiOperationId":"getCacheConfiguration","summary":"Retrieve a cache configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cache_configurations_object","exampleIds":["paths/~1v3~1cache-configurations~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/cache_configurations_object","exampleIds":["paths/~1v3~1cache-configurations~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1cache-configurations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/cache_configurations_object","exampleIds":["paths/~1v3~1cache-configurations~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cache_configurations_object","exampleIds":["paths/~1v3~1cache-configurations~1{id}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cache-configurations/getcacheconfiguration"}],"panels":[]}]},"httpPath":"/v3/cache-configurations/{id}"},{"label":"Delete a cache configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-configurations/deletecacheconfiguration","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-configurations/deletecacheconfiguration","metadata":{"seo":{"title":"Delete a cache configuration","description":"Deletes a cache configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCacheConfiguration","name":"Delete a cache configuration","isWebhook":false,"pointer":"/paths/~1v3~1cache-configurations~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a cache configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a cache configuration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Cache Configuration identifier","required":true}],"pointer":"/paths/~1v3~1cache-configurations~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/cache-configurations/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/cache-configurations/{id}","href":"cache-configurations/deletecacheconfiguration","openApiOperationId":"deleteCacheConfiguration","summary":"Delete a cache configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1cache-configurations~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cache-configurations/deletecacheconfiguration"}],"panels":[]}]},"httpPath":"/v3/cache-configurations/{id}"},{"label":"Update a cache configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-configurations/updatecacheconfiguration","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-configurations/updatecacheconfiguration","metadata":{"seo":{"title":"Update a cache configuration","description":"Updates a cache configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCacheConfiguration","name":"Update a cache configuration","isWebhook":false,"pointer":"/paths/~1v3~1cache-configurations~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a cache configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a cache configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Cache Configuration identifier","required":true}],"pointer":"/paths/~1v3~1cache-configurations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7","pointer":"/paths/~1v3~1cache-configurations~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/cache-configurations/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7"}},"responseCodes":["200","400"],"pointer":"/v3/cache-configurations/{id}","href":"cache-configurations/updatecacheconfiguration","openApiOperationId":"updateCacheConfiguration","summary":"Update a cache configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1cache-configurations~1{id}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cache-configurations/updatecacheconfiguration"}],"panels":[]}]},"httpPath":"/v3/cache-configurations/{id}"}],"content":{"contentType":"group","meta":{"name":"Cache Configurations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cache Configurations","showPageActions":true},{"nodeType":"markdoc","content":"Contains operations on the Cache Configurations resource."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/cache-configurations","summary":"List cache configurations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cache-configurations/listcacheconfigurations","deprecated":false},{"title":"/v3/cache-configurations","summary":"Create a cache configuration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cache-configurations/createcacheconfiguration","deprecated":false},{"title":"/v3/cache-configurations/{id}","summary":"Retrieve a cache configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cache-configurations/getcacheconfiguration","deprecated":false},{"title":"/v3/cache-configurations/{id}","summary":"Delete a cache configuration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cache-configurations/deletecacheconfiguration","deprecated":false},{"title":"/v3/cache-configurations/{id}","summary":"Update a cache configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cache-configurations/updatecacheconfiguration","deprecated":false}]}]}]}]}},{"type":"group","label":"Cache Management","link":"/zephr-api-reference/zephr-admin-api/cache-management","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-management","items":[{"label":"Evict cached origin requests","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-management/evictorigin","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-management/evictorigin","metadata":{"seo":{"title":"Evict cached origin requests","description":"Evicts all cached origin requests with path matching the supplied regular expression."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"evictOrigin","name":"Evict cached origin requests","isWebhook":false,"pointer":"/paths/~1v3~1cache-management~1evict-origin/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Evict cached origin requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Evicts all cached origin requests with path matching the supplied regular expression."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1v3~1cache-management~1evict-origin/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_8","exampleIds":["paths/~1v3~1cache-management~1evict-origin/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v3~1cache-management~1evict-origin/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/cache-management/evict-origin","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1v3~1cache-management~1evict-origin/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","500"],"pointer":"/v3/cache-management/evict-origin","href":"cache-management/evictorigin","openApiOperationId":"evictOrigin","summary":"Evict cached origin requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_8","exampleIds":["paths/~1v3~1cache-management~1evict-origin/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1v3~1cache-management~1evict-origin/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"400","description":"Bad Request","headers":{}},{"code":"500","description":"Internal Server Error","headers":{}}],"pointer":"/paths/~1v3~1cache-management~1evict-origin/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cache-management/evictorigin"}],"panels":[]}]},"httpPath":"/v3/cache-management/evict-origin"},{"label":"Evict cached origin requests (V4)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-management/evictoriginsitev4","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-management/evictoriginsitev4","metadata":{"seo":{"title":"Evict cached origin requests (V4)","description":"Evicts all cached origin requests with path matching the supplied regular expression."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"evictOriginSiteV4","name":"Evict cached origin requests (V4)","isWebhook":false,"pointer":"/paths/~1v4~1cache-management~1evict-origin/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Evict cached origin requests (V4)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Evicts all cached origin requests with path matching the supplied regular expression."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1v4~1cache-management~1evict-origin/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_8","exampleIds":["paths/~1v4~1cache-management~1evict-origin/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v4~1cache-management~1evict-origin/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/cache-management/evict-origin","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1v4~1cache-management~1evict-origin/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","500"],"pointer":"/v4/cache-management/evict-origin","href":"cache-management/evictoriginsitev4","openApiOperationId":"evictOriginSiteV4","summary":"Evict cached origin requests (V4)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_8","exampleIds":["paths/~1v4~1cache-management~1evict-origin/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1v4~1cache-management~1evict-origin/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"400","description":"Bad Request","headers":{}},{"code":"500","description":"Internal Server Error","headers":{}}],"pointer":"/paths/~1v4~1cache-management~1evict-origin/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cache-management/evictoriginsitev4"}],"panels":[]}]},"httpPath":"/v4/cache-management/evict-origin"},{"label":"Evict cached origin requests for a given site in V4","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/cache-management/evictoriginv4","routeSlug":"/zephr-api-reference/zephr-admin-api/cache-management/evictoriginv4","metadata":{"seo":{"title":"Evict cached origin requests for a given site in V4","description":"Evicts all of the origin cache matching the path pattern provided in the request body for a given site, evicts all paths if .* is provided as path pattern."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"evictOriginV4","name":"Evict cached origin requests for a given site in V4","isWebhook":false,"pointer":"/paths/~1v4~1cache-management~1evict-origin~1{site}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Evict cached origin requests for a given site in V4","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Evicts all of the origin cache matching the path pattern provided in the request body for a given site, evicts all paths if .* is provided as path pattern."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"site","in":"path","schemaId":"schema_0","description":"Site Slug","required":true}],"pointer":"/paths/~1v4~1cache-management~1evict-origin~1{site}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1v4~1cache-management~1evict-origin~1{site}/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_8","exampleIds":["paths/~1v4~1cache-management~1evict-origin~1{site}/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v4~1cache-management~1evict-origin~1{site}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/cache-management/evict-origin/{site}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"site","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1v4~1cache-management~1evict-origin~1{site}/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","403"],"pointer":"/v4/cache-management/evict-origin/{site}","href":"cache-management/evictoriginv4","openApiOperationId":"evictOriginV4","summary":"Evict cached origin requests for a given site in V4"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_8","exampleIds":["paths/~1v4~1cache-management~1evict-origin~1{site}/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1v4~1cache-management~1evict-origin~1{site}/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The specified origin cache has successfully been evicted.","headers":{}},{"code":"400","description":"Bad Request. Path to delete must be a valid regex","headers":{}},{"code":"403","description":"Forbidden. Not permitted for V3 tenant.","headers":{}}],"pointer":"/paths/~1v4~1cache-management~1evict-origin~1{site}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cache-management/evictoriginv4"}],"panels":[]}]},"httpPath":"/v4/cache-management/evict-origin/{site}"}],"content":{"contentType":"group","meta":{"name":"Cache Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cache Management","showPageActions":true},{"nodeType":"markdoc","content":"Cache Mangement."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/cache-management/evict-origin","summary":"Evict cached origin requests","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cache-management/evictorigin","deprecated":false},{"title":"/v4/cache-management/evict-origin","summary":"Evict cached origin requests (V4)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cache-management/evictoriginsitev4","deprecated":false},{"title":"/v4/cache-management/evict-origin/{site}","summary":"Evict cached origin requests for a given site in V4","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cache-management/evictoriginv4","deprecated":false}]}]}]}]}},{"type":"group","label":"Company","link":"/zephr-api-reference/zephr-admin-api/company","routeSlug":"/zephr-api-reference/zephr-admin-api/company","items":[{"label":"List companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/company/listcompanies","routeSlug":"/zephr-api-reference/zephr-admin-api/company/listcompanies","metadata":{"seo":{"title":"List companies","description":"Retrieves a list of companies wrapped in the element \"results\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCompanies","name":"List companies","isWebhook":false,"pointer":"/paths/~1v3~1companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of companies wrapped in the element \"results\"."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/companies","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/companies","href":"company/listcompanies","openApiOperationId":"listCompanies","summary":"List companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/companies","exampleIds":["paths/~1v3~1companies/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/companies","exampleIds":["paths/~1v3~1companies/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/companies","exampleIds":["paths/~1v3~1companies/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/companies","exampleIds":["paths/~1v3~1companies/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/listcompanies"}],"panels":[]}]},"httpPath":"/v3/companies"},{"label":"Create a company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/company/createcompany","routeSlug":"/zephr-api-reference/zephr-admin-api/company/createcompany","metadata":{"seo":{"title":"Create a company","description":"Creates a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCompany","name":"Create a company","isWebhook":false,"pointer":"/paths/~1v3~1companies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_9"}},"schemaId":"schema_9","pointer":"/paths/~1v3~1companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/companies","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_9"}},"responseCodes":["201","400"],"pointer":"/v3/companies","href":"company/createcompany","openApiOperationId":"createCompany","summary":"Create a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_9","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_9"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1companies/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/createcompany"}],"panels":[]}]},"httpPath":"/v3/companies"},{"label":"Retrieve a company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/company/getcompany","routeSlug":"/zephr-api-reference/zephr-admin-api/company/getcompany","metadata":{"seo":{"title":"Retrieve a company","description":"Retrieves a single company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCompany","name":"Retrieve a company","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Company identifier","required":true}],"pointer":"/paths/~1v3~1companies~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/companies/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/companies/{id}","href":"company/getcompany","openApiOperationId":"getCompany","summary":"Retrieve a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1v3~1companies~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/company","exampleIds":["paths/~1v3~1companies~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1companies~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","exampleIds":["paths/~1v3~1companies~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1v3~1companies~1{id}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/getcompany"}],"panels":[]}]},"httpPath":"/v3/companies/{id}"},{"label":"Delete a company","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/company/deletecompany","routeSlug":"/zephr-api-reference/zephr-admin-api/company/deletecompany","metadata":{"seo":{"title":"Delete a company","description":"Deletes a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCompany","name":"Delete a company","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Company identifier","required":true}],"pointer":"/paths/~1v3~1companies~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/companies/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/companies/{id}","href":"company/deletecompany","openApiOperationId":"deleteCompany","summary":"Delete a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1companies~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/deletecompany"}],"panels":[]}]},"httpPath":"/v3/companies/{id}"},{"label":"Update a company","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/company/updatecompany","routeSlug":"/zephr-api-reference/zephr-admin-api/company/updatecompany","metadata":{"seo":{"title":"Update a company","description":"Updates a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCompany","name":"Update a company","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Company identifier","required":true}],"pointer":"/paths/~1v3~1companies~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_9"}},"schemaId":"schema_9","pointer":"/paths/~1v3~1companies~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/companies/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_9"}},"responseCodes":["201","400"],"pointer":"/v3/companies/{id}","href":"company/updatecompany","openApiOperationId":"updateCompany","summary":"Update a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_9","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_9"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1companies~1{id}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/updatecompany"}],"panels":[]}]},"httpPath":"/v3/companies/{id}"},{"label":"Create a company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/company/paths/~1v4~1companies/post","routeSlug":"/zephr-api-reference/zephr-admin-api/company/paths/~1v4~1companies/post","metadata":{"seo":{"title":"Create a company","description":"Creates a company with the details specified in the request body"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a company","isWebhook":false,"pointer":"/paths/~1v4~1companies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a company with the details specified in the request body"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_10"}},"schemaId":"schema_10","pointer":"/paths/~1v4~1companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/companies","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_10"}},"responseCodes":["201","400"],"pointer":"/v4/companies","href":"company/paths/~1v4~1companies/post","summary":"Create a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_10","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_10"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK - Company has been created successfully"},{"code":"400","description":"Bad Request - Company name is missing from the request"}],"pointer":"/paths/~1v4~1companies/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/paths/~1v4~1companies/post"}],"panels":[]}]},"httpPath":"/v4/companies"},{"label":"Retrieve a company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/company/paths/~1v4~1companies~1{companyid}/get","routeSlug":"/zephr-api-reference/zephr-admin-api/company/paths/~1v4~1companies~1{companyid}/get","metadata":{"seo":{"title":"Retrieve a company","description":"Retrieves company information for a company specified by the provided identifier (companyId)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Retrieve a company","isWebhook":false,"pointer":"/paths/~1v4~1companies~1{companyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves company information for a company specified by the provided identifier ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"The company's unique identifier","required":true,"example":"1f6841a8-7f3b-4505-856e-4549be433545"}],"pointer":"/paths/~1v4~1companies~1{companyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/companies/{companyId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"1f6841a8-7f3b-4505-856e-4549be433545","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/companies/{companyId}","href":"company/paths/~1v4~1companies~1{companyid}/get","summary":"Retrieve a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Company information was successfully retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/companyv4","exampleIds":["paths/~1v4~1companies~1{companyId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/companyv4","exampleIds":["paths/~1v4~1companies~1{companyId}/get/responses/200/content/application~1json/example"],"headers":{}},{"code":"404","description":"Not found - No companies were found with the supplied identifier","headers":{}}],"pointer":"/paths/~1v4~1companies~1{companyId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/companyv4","exampleIds":["paths/~1v4~1companies~1{companyId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/companyv4","exampleIds":["paths/~1v4~1companies~1{companyId}/get/responses/200/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company/paths/~1v4~1companies~1{companyid}/get"}],"panels":[]}]},"httpPath":"/v4/companies/{companyId}"}],"content":{"contentType":"group","meta":{"name":"Company"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Company."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/companies","summary":"List companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/company/listcompanies","deprecated":false},{"title":"/v3/companies","summary":"Create a company","prefix":{"name":"post","color":"post"},"badges":[],"link":"/company/createcompany","deprecated":false},{"title":"/v3/companies/{id}","summary":"Retrieve a company","prefix":{"name":"get","color":"get"},"badges":[],"link":"/company/getcompany","deprecated":false},{"title":"/v3/companies/{id}","summary":"Delete a company","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/company/deletecompany","deprecated":false},{"title":"/v3/companies/{id}","summary":"Update a company","prefix":{"name":"put","color":"put"},"badges":[],"link":"/company/updatecompany","deprecated":false},{"title":"/v4/companies","summary":"Create a company","prefix":{"name":"post","color":"post"},"badges":[],"link":"/company/paths/~1v4~1companies/post","deprecated":false},{"title":"/v4/companies/{companyId}","summary":"Retrieve a company","prefix":{"name":"get","color":"get"},"badges":[],"link":"/company/paths/~1v4~1companies~1{companyid}/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Component Library","link":"/zephr-api-reference/zephr-admin-api/component-library","routeSlug":"/zephr-api-reference/zephr-admin-api/component-library","items":[{"label":"Generate Thumbnail Upload URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/component-library/generatethumbnailuploadurl","routeSlug":"/zephr-api-reference/zephr-admin-api/component-library/generatethumbnailuploadurl","metadata":{"seo":{"title":"Generate Thumbnail Upload URL","description":"Generates a pre-signed URL for securely uploading a thumbnail image. The link expires after 10 minutes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateThumbnailUploadUrl","name":"Generate Thumbnail Upload URL","isWebhook":false,"pointer":"/paths/~1v4~1thumbnails~1upload-url/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate Thumbnail Upload URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates a pre-signed URL for securely uploading a thumbnail image. The link expires after "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 minutes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Considerations:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploaded images are not optimized by the server; please upload images pre-optimized for web use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each uploaded file receives a unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thumbnailId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for reference within your application, but the file name in the bucket is derived from this ID, ensuring no conflicts with existing files."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_11"}},"schemaId":"schema_11","pointer":"/paths/~1v4~1thumbnails~1upload-url/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/thumbnails/upload-url","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_11"}},"responseCodes":["200","400","401"],"pointer":"/v4/thumbnails/upload-url","href":"component-library/generatethumbnailuploadurl","openApiOperationId":"generateThumbnailUploadUrl","summary":"Generate Thumbnail Upload URL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_11","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_11"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully generated URL for thumbnail upload.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1v4~1thumbnails~1upload-url/post/responses/200/content/application~1json/examples/application~1json"]}},"schemaId":"schema_12","exampleIds":["paths/~1v4~1thumbnails~1upload-url/post/responses/200/content/application~1json/examples/application~1json"]},{"code":"400","description":"The request is invalid. A required attribute is missing or an attribute did not meet the expected criteria.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1v4~1thumbnails~1upload-url/post/responses/400/content/application~1json/examples/missingName","paths/~1v4~1thumbnails~1upload-url/post/responses/400/content/application~1json/examples/invalidType"]}},"schemaId":"schema_13","exampleIds":["paths/~1v4~1thumbnails~1upload-url/post/responses/400/content/application~1json/examples/missingName","paths/~1v4~1thumbnails~1upload-url/post/responses/400/content/application~1json/examples/invalidType"]},{"code":"401","description":"Authentication credentials were not provided or are invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1v4~1thumbnails~1upload-url/post/responses/401/content/application~1json/examples/missingCredentials"]}},"schemaId":"schema_13","exampleIds":["paths/~1v4~1thumbnails~1upload-url/post/responses/401/content/application~1json/examples/missingCredentials"]}],"pointer":"/paths/~1v4~1thumbnails~1upload-url/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","exampleIds":["paths/~1v4~1thumbnails~1upload-url/post/responses/200/content/application~1json/examples/application~1json"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1v4~1thumbnails~1upload-url/post/responses/200/content/application~1json/examples/application~1json"]}}},{"code":"400","schemaId":"schema_13","exampleIds":["paths/~1v4~1thumbnails~1upload-url/post/responses/400/content/application~1json/examples/missingName","paths/~1v4~1thumbnails~1upload-url/post/responses/400/content/application~1json/examples/invalidType"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1v4~1thumbnails~1upload-url/post/responses/400/content/application~1json/examples/missingName","paths/~1v4~1thumbnails~1upload-url/post/responses/400/content/application~1json/examples/invalidType"]}}},{"code":"401","schemaId":"schema_13","exampleIds":["paths/~1v4~1thumbnails~1upload-url/post/responses/401/content/application~1json/examples/missingCredentials"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1v4~1thumbnails~1upload-url/post/responses/401/content/application~1json/examples/missingCredentials"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/component-library/generatethumbnailuploadurl"}],"panels":[]}]},"httpPath":"/v4/thumbnails/upload-url"}],"content":{"contentType":"group","meta":{"name":"Component Library"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Component Library","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Library Component."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/thumbnails/upload-url","summary":"Generate Thumbnail Upload URL","prefix":{"name":"post","color":"post"},"badges":[],"link":"/component-library/generatethumbnailuploadurl","deprecated":false}]}]}]}]}},{"type":"group","label":"Configuration","link":"/zephr-api-reference/zephr-admin-api/configuration","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration","items":[{"label":"Save the tenant configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/configuration/saveconfiguration","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration/saveconfiguration","metadata":{"seo":{"title":"Save the tenant configuration","description":"Creates or updates the tenant configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"saveConfiguration","name":"Save the tenant configuration","isWebhook":false,"pointer":"/paths/~1v3~1configuration/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Save the tenant configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates the tenant configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_14"}},"schemaId":"schema_14","pointer":"/paths/~1v3~1configuration/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/configuration","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_14"}},"responseCodes":["200","400"],"pointer":"/v3/configuration","href":"configuration/saveconfiguration","openApiOperationId":"saveConfiguration","summary":"Save the tenant configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_14","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_14"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1configuration/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/saveconfiguration"}],"panels":[]}]},"httpPath":"/v3/configuration"},{"label":"Retrieve the tenant configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/configuration/getconfiguration","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration/getconfiguration","metadata":{"seo":{"title":"Retrieve the tenant configuration","description":"Retrieves the tenant configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConfiguration","name":"Retrieve the tenant configuration","isWebhook":false,"pointer":"/paths/~1v3~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the tenant configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the tenant configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/configuration","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/configuration","href":"configuration/getconfiguration","openApiOperationId":"getConfiguration","summary":"Retrieve the tenant configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/configuration","exampleIds":["paths/~1v3~1configuration/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/configuration","exampleIds":["paths/~1v3~1configuration/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/configuration","exampleIds":["paths/~1v3~1configuration/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/configuration","exampleIds":["paths/~1v3~1configuration/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/getconfiguration"}],"panels":[]}]},"httpPath":"/v3/configuration"},{"label":"Update blacklisted email domains","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/configuration/updateblacklistedemaildomains","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration/updateblacklistedemaildomains","metadata":{"seo":{"title":"Update blacklisted email domains","description":"Replaces the full list of blacklisted email domains for the tenant. Existing blacklisted email domains are removed and replaced with the values provided in the request body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBlacklistedEmailDomains","name":"Update blacklisted email domains","isWebhook":false,"pointer":"/paths/~1v4~1blacklisted-email-domains/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update blacklisted email domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces the full list of blacklisted email domains for the tenant.\nExisting blacklisted email domains are removed and replaced with the values provided in the request body.\n\nTo remove all blacklisted email domains, provide an empty array.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/blacklisted-email-domains-request","exampleIds":["paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/singleDomain","paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/multipleDomains","paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/emptyList"]}},"schemaId":"components/schemas/blacklisted-email-domains-request","exampleIds":["paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/singleDomain","paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/multipleDomains","paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/emptyList"],"pointer":"/paths/~1v4~1blacklisted-email-domains/put/requestBody","description":"List of email domains to blacklist"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/blacklisted-email-domains","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/blacklisted-email-domains-request","exampleIds":["paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/singleDomain","paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/multipleDomains","paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/emptyList"]}},"responseCodes":["200","201","400"],"pointer":"/v4/blacklisted-email-domains","href":"configuration/updateblacklistedemaildomains","openApiOperationId":"updateBlacklistedEmailDomains","summary":"Update blacklisted email domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"components/schemas/blacklisted-email-domains-request","exampleIds":["paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/singleDomain","paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/multipleDomains","paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/emptyList"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/blacklisted-email-domains-request","exampleIds":["paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/singleDomain","paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/multipleDomains","paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/emptyList"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Blacklisted email domains were updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/blacklisted-email-domains-response","exampleIds":["paths/~1v4~1blacklisted-email-domains/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/blacklisted-email-domains-response","exampleIds":["paths/~1v4~1blacklisted-email-domains/put/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"201","description":"Created - Blacklisted email domains were created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/blacklisted-email-domains-response","exampleIds":["paths/~1v4~1blacklisted-email-domains/put/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/blacklisted-email-domains-response","exampleIds":["paths/~1v4~1blacklisted-email-domains/put/responses/201/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad request","headers":{}}],"pointer":"/paths/~1v4~1blacklisted-email-domains/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/blacklisted-email-domains-response","exampleIds":["paths/~1v4~1blacklisted-email-domains/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/blacklisted-email-domains-response","exampleIds":["paths/~1v4~1blacklisted-email-domains/put/responses/200/content/application~1json/examples/response"]}}},{"code":"201","schemaId":"components/schemas/blacklisted-email-domains-response","exampleIds":["paths/~1v4~1blacklisted-email-domains/put/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/blacklisted-email-domains-response","exampleIds":["paths/~1v4~1blacklisted-email-domains/put/responses/201/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/updateblacklistedemaildomains"}],"panels":[]}]},"httpPath":"/v4/blacklisted-email-domains"},{"label":"List blacklisted email domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/configuration/listblacklistedemaildomains","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration/listblacklistedemaildomains","metadata":{"seo":{"title":"List blacklisted email domains","description":"Fetches the list of blacklisted email addresses for the tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBlacklistedEmailDomains","name":"List blacklisted email domains","isWebhook":false,"pointer":"/paths/~1v4~1blacklisted-email-domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List blacklisted email domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches the list of blacklisted email addresses for the tenant."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/blacklisted-email-domains","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v4/blacklisted-email-domains","href":"configuration/listblacklistedemaildomains","openApiOperationId":"listBlacklistedEmailDomains","summary":"List blacklisted email domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Blacklisted email domains were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15","exampleIds":["paths/~1v4~1blacklisted-email-domains/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_15","exampleIds":["paths/~1v4~1blacklisted-email-domains/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"Bad request"}],"pointer":"/paths/~1v4~1blacklisted-email-domains/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_15","exampleIds":["paths/~1v4~1blacklisted-email-domains/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15","exampleIds":["paths/~1v4~1blacklisted-email-domains/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/listblacklistedemaildomains"}],"panels":[]}]},"httpPath":"/v4/blacklisted-email-domains"},{"label":"Install a tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/configuration/installtenant","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration/installtenant","metadata":{"seo":{"title":"Install a tenant","description":"Installs a tenant in Blaize."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"installTenant","name":"Install a tenant","isWebhook":false,"pointer":"/paths/~1v3~1initialize/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Install a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Installs a tenant in Blaize."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/initialize","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/initialize","href":"configuration/installtenant","openApiOperationId":"installTenant","summary":"Install a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1initialize/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/installtenant"}],"panels":[]}]},"httpPath":"/v3/initialize"},{"label":"Create a cert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/configuration/createcert","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration/createcert","metadata":{"seo":{"title":"Create a cert","description":"Creates a cert."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCert","name":"Create a cert","isWebhook":false,"pointer":"/paths/~1v3~1certs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a cert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a cert."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16","pointer":"/paths/~1v3~1certs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/certs","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_16"}},"responseCodes":["201","400"],"pointer":"/v3/certs","href":"configuration/createcert","openApiOperationId":"createCert","summary":"Create a cert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_16"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1certs/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/createcert"}],"panels":[]}]},"httpPath":"/v3/certs"},{"label":"Delete a cert","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/configuration/deletecert","routeSlug":"/zephr-api-reference/zephr-admin-api/configuration/deletecert","metadata":{"seo":{"title":"Delete a cert","description":"Deletes a cert."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCert","name":"Delete a cert","isWebhook":false,"pointer":"/paths/~1v3~1certs/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a cert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a cert."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/certs","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/certs","href":"configuration/deletecert","openApiOperationId":"deleteCert","summary":"Delete a cert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1certs/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/deletecert"}],"panels":[]}]},"httpPath":"/v3/certs"}],"content":{"contentType":"group","meta":{"name":"Configuration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configuration","showPageActions":true},{"nodeType":"markdoc","content":"Blaize tenant configuration."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/configuration","summary":"Save the tenant configuration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/configuration/saveconfiguration","deprecated":false},{"title":"/v3/configuration","summary":"Retrieve the tenant configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration/getconfiguration","deprecated":false},{"title":"/v4/blacklisted-email-domains","summary":"Update blacklisted email domains","prefix":{"name":"put","color":"put"},"badges":[],"link":"/configuration/updateblacklistedemaildomains","deprecated":false},{"title":"/v4/blacklisted-email-domains","summary":"List blacklisted email domains","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration/listblacklistedemaildomains","deprecated":false},{"title":"/v3/initialize","summary":"Install a tenant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/configuration/installtenant","deprecated":false},{"title":"/v3/certs","summary":"Create a cert","prefix":{"name":"post","color":"post"},"badges":[],"link":"/configuration/createcert","deprecated":false},{"title":"/v3/certs","summary":"Delete a cert","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/configuration/deletecert","deprecated":false}]}]}]}]}},{"type":"group","label":"Credit","link":"/zephr-api-reference/zephr-admin-api/credit","routeSlug":"/zephr-api-reference/zephr-admin-api/credit","items":[{"label":"List credits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/credit/credits","routeSlug":"/zephr-api-reference/zephr-admin-api/credit/credits","metadata":{"seo":{"title":"List credits","description":"Retrieves a list of credits wrapped in the element \"results\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Credits","name":"List credits","isWebhook":false,"pointer":"/paths/~1v3~1credits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List credits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of credits wrapped in the element \"results\"."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/credits","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/credits","href":"credit/credits","openApiOperationId":"Credits","summary":"List credits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/credits","exampleIds":["paths/~1v3~1credits/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/credits","exampleIds":["paths/~1v3~1credits/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1credits/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/credits","exampleIds":["paths/~1v3~1credits/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/credits","exampleIds":["paths/~1v3~1credits/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit/credits"}],"panels":[]}]},"httpPath":"/v3/credits"},{"label":"Create Credit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/credit/createcredits","routeSlug":"/zephr-api-reference/zephr-admin-api/credit/createcredits","metadata":{"seo":{"title":"Create Credit","description":"Create an Credit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCredits","name":"Create Credit","isWebhook":false,"pointer":"/paths/~1v3~1credits/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Credit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an Credit"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_17"}},"schemaId":"schema_17","pointer":"/paths/~1v3~1credits/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/credits","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_17"}},"responseCodes":["201","400"],"pointer":"/v3/credits","href":"credit/createcredits","openApiOperationId":"createCredits","summary":"Create Credit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_17","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_17"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1credits/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit/createcredits"}],"panels":[]}]},"httpPath":"/v3/credits"},{"label":"Create a credit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/credit/createcredit","routeSlug":"/zephr-api-reference/zephr-admin-api/credit/createcredit","metadata":{"seo":{"title":"Create a credit","description":"Creates a credit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCredit","name":"Create a credit","isWebhook":false,"pointer":"/paths/~1v3~1credits~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a credit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a credit."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Credit identifier","required":true}],"pointer":"/paths/~1v3~1credits~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_17"}},"schemaId":"schema_17","pointer":"/paths/~1v3~1credits~1{id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/credits/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_17"}},"responseCodes":["201","400"],"pointer":"/v3/credits/{id}","href":"credit/createcredit","openApiOperationId":"createCredit","summary":"Create a credit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_17","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_17"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1credits~1{id}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit/createcredit"}],"panels":[]}]},"httpPath":"/v3/credits/{id}"},{"label":"Retrieve a credit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/credit/getcredit","routeSlug":"/zephr-api-reference/zephr-admin-api/credit/getcredit","metadata":{"seo":{"title":"Retrieve a credit","description":"Retrieves a single credit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCredit","name":"Retrieve a credit","isWebhook":false,"pointer":"/paths/~1v3~1credits~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a credit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single credit."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Credit identifier","required":true}],"pointer":"/paths/~1v3~1credits~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/credits/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/credits/{id}","href":"credit/getcredit","openApiOperationId":"getCredit","summary":"Retrieve a credit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/credit","exampleIds":["paths/~1v3~1credits~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/credit","exampleIds":["paths/~1v3~1credits~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1credits~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/credit","exampleIds":["paths/~1v3~1credits~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/credit","exampleIds":["paths/~1v3~1credits~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit/getcredit"}],"panels":[]}]},"httpPath":"/v3/credits/{id}"},{"label":"Delete a credit","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/credit/deletecredit","routeSlug":"/zephr-api-reference/zephr-admin-api/credit/deletecredit","metadata":{"seo":{"title":"Delete a credit","description":"Deletes a credit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCredit","name":"Delete a credit","isWebhook":false,"pointer":"/paths/~1v3~1credits~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a credit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a credit."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Credit identifier","required":true}],"pointer":"/paths/~1v3~1credits~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/credits/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/credits/{id}","href":"credit/deletecredit","openApiOperationId":"deleteCredit","summary":"Delete a credit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1credits~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit/deletecredit"}],"panels":[]}]},"httpPath":"/v3/credits/{id}"}],"content":{"contentType":"group","meta":{"name":"Credit"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Credit."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/credits","summary":"List credits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit/credits","deprecated":false},{"title":"/v3/credits","summary":"Create Credit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit/createcredits","deprecated":false},{"title":"/v3/credits/{id}","summary":"Create a credit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit/createcredit","deprecated":false},{"title":"/v3/credits/{id}","summary":"Retrieve a credit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit/getcredit","deprecated":false},{"title":"/v3/credits/{id}","summary":"Delete a credit","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/credit/deletecredit","deprecated":false}]}]}]}]}},{"type":"group","label":"Decision Engine","link":"/zephr-api-reference/zephr-admin-api/decision-engine","routeSlug":"/zephr-api-reference/zephr-admin-api/decision-engine","items":[{"label":"Invoke the decision engine","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/decision-engine/invokedecisionengine","routeSlug":"/zephr-api-reference/zephr-admin-api/decision-engine/invokedecisionengine","metadata":{"seo":{"title":"Invoke the decision engine","description":"Invokes the decision engine. The Blaize Decision Engine can be invoked via the Admin API to calculate an HTTP Response based upon Request-Level Rules created in the Admin Console. This functionality is build into the Blaize Dynamic CDN but the API variant is useful for CMS or edge side integrations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invokeDecisionEngine","name":"Invoke the decision engine","isWebhook":false,"pointer":"/paths/~1v3~1decision-engine/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoke the decision engine","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Invokes the decision engine.\nThe Blaize Decision Engine can be invoked via the Admin API to calculate an HTTP Response based upon Request-Level Rules created in the Admin Console. This functionality is build into the Blaize Dynamic CDN but the API variant is useful for CMS or edge side integrations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_18"}},"schemaId":"schema_18","pointer":"/paths/~1v3~1decision-engine/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/decision-engine","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_18"}},"responseCodes":["200","409"],"pointer":"/v3/decision-engine","href":"decision-engine/invokedecisionengine","openApiOperationId":"invokeDecisionEngine","summary":"Invoke the decision engine"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_18","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_18"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/access-decision-response","exampleIds":["paths/~1v3~1decision-engine/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/access-decision-response","exampleIds":["paths/~1v3~1decision-engine/post/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"409","description":"Conflict","headers":{}}],"pointer":"/paths/~1v3~1decision-engine/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/access-decision-response","exampleIds":["paths/~1v3~1decision-engine/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/access-decision-response","exampleIds":["paths/~1v3~1decision-engine/post/responses/200/content/application~1json/examples/response"]}}},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/decision-engine/invokedecisionengine"}],"panels":[]}]},"httpPath":"/v3/decision-engine"}],"content":{"contentType":"group","meta":{"name":"Decision Engine"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Decision Engine","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/decision-engine","summary":"Invoke the decision engine","prefix":{"name":"post","color":"post"},"badges":[],"link":"/decision-engine/invokedecisionengine","deprecated":false}]}]}]}]}},{"type":"group","label":"Email Templates","link":"/zephr-api-reference/zephr-admin-api/email-templates","routeSlug":"/zephr-api-reference/zephr-admin-api/email-templates","items":[{"label":"List email templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/email-templates/listemailtemplates","routeSlug":"/zephr-api-reference/zephr-admin-api/email-templates/listemailtemplates","metadata":{"seo":{"title":"List email templates","description":"Retrieves a list of email templates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEmailTemplates","name":"List email templates","isWebhook":false,"pointer":"/paths/~1v4~1email-templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List email templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of email templates."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/email-templates","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/email-templates","href":"email-templates/listemailtemplates","openApiOperationId":"listEmailTemplates","summary":"List email templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/email-templates","exampleIds":["paths/~1v4~1email-templates/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/email-templates","exampleIds":["paths/~1v4~1email-templates/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v4~1email-templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/email-templates","exampleIds":["paths/~1v4~1email-templates/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/email-templates","exampleIds":["paths/~1v4~1email-templates/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-templates/listemailtemplates"}],"panels":[]}]},"httpPath":"/v4/email-templates"},{"label":"Retrieve an email template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/email-templates/getemailtemplate","routeSlug":"/zephr-api-reference/zephr-admin-api/email-templates/getemailtemplate","metadata":{"seo":{"title":"Retrieve an email template","description":"Retrieves a single email template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmailTemplate","name":"Retrieve an email template","isWebhook":false,"pointer":"/paths/~1v4~1email-templates~1{slug}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an email template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single email template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"slug","in":"path","schemaId":"schema_0","description":"Slug of the Email template","required":true}],"pointer":"/paths/~1v4~1email-templates~1{slug}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/email-templates/{slug}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"slug","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/email-templates/{slug}","href":"email-templates/getemailtemplate","openApiOperationId":"getEmailTemplate","summary":"Retrieve an email template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/email-template","exampleIds":["paths/~1v4~1email-templates~1{slug}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/email-template","exampleIds":["paths/~1v4~1email-templates~1{slug}/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v4~1email-templates~1{slug}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/email-template","exampleIds":["paths/~1v4~1email-templates~1{slug}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/email-template","exampleIds":["paths/~1v4~1email-templates~1{slug}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-templates/getemailtemplate"}],"panels":[]}]},"httpPath":"/v4/email-templates/{slug}"},{"label":"Delete an email template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/email-templates/deleteemailtemplate","routeSlug":"/zephr-api-reference/zephr-admin-api/email-templates/deleteemailtemplate","metadata":{"seo":{"title":"Delete an email template","description":"Deletes an email template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEmailTemplate","name":"Delete an email template","isWebhook":false,"pointer":"/paths/~1v4~1email-templates~1{slug}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an email template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an email template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"slug","in":"path","schemaId":"schema_0","description":"Slug of the Email template","required":true}],"pointer":"/paths/~1v4~1email-templates~1{slug}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/email-templates/{slug}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"slug","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/email-templates/{slug}","href":"email-templates/deleteemailtemplate","openApiOperationId":"deleteEmailTemplate","summary":"Delete an email template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v4~1email-templates~1{slug}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-templates/deleteemailtemplate"}],"panels":[]}]},"httpPath":"/v4/email-templates/{slug}"},{"label":"Save an email template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/email-templates/saveemailtemplate","routeSlug":"/zephr-api-reference/zephr-admin-api/email-templates/saveemailtemplate","metadata":{"seo":{"title":"Save an email template","description":"Saves an email template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"saveEmailTemplate","name":"Save an email template","isWebhook":false,"pointer":"/paths/~1v4~1email-templates~1{slug}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Save an email template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Saves an email template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"slug","in":"path","schemaId":"schema_0","description":"Slug of the Email template","required":true}],"pointer":"/paths/~1v4~1email-templates~1{slug}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_19"}},"schemaId":"schema_19","pointer":"/paths/~1v4~1email-templates~1{slug}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/email-templates/{slug}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"slug","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_19"}},"responseCodes":["200","400"],"pointer":"/v4/email-templates/{slug}","href":"email-templates/saveemailtemplate","openApiOperationId":"saveEmailTemplate","summary":"Save an email template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_19","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_19"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v4~1email-templates~1{slug}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-templates/saveemailtemplate"}],"panels":[]}]},"httpPath":"/v4/email-templates/{slug}"}],"content":{"contentType":"group","meta":{"name":"Email Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email Templates","showPageActions":true},{"nodeType":"markdoc","content":"Actions on email templates."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/email-templates","summary":"List email templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email-templates/listemailtemplates","deprecated":false},{"title":"/v4/email-templates/{slug}","summary":"Retrieve an email template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email-templates/getemailtemplate","deprecated":false},{"title":"/v4/email-templates/{slug}","summary":"Delete an email template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/email-templates/deleteemailtemplate","deprecated":false},{"title":"/v4/email-templates/{slug}","summary":"Save an email template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/email-templates/saveemailtemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Entitlement","link":"/zephr-api-reference/zephr-admin-api/entitlement","routeSlug":"/zephr-api-reference/zephr-admin-api/entitlement","items":[{"label":"List entitlements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/entitlement/listentitlements","routeSlug":"/zephr-api-reference/zephr-admin-api/entitlement/listentitlements","metadata":{"seo":{"title":"List entitlements","description":"Retrieves a list of entitlements wrapped in the element \"results\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntitlements","name":"List entitlements","isWebhook":false,"pointer":"/paths/~1v3~1entitlements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List entitlements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of entitlements wrapped in the element \"results\"."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/entitlements","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/entitlements","href":"entitlement/listentitlements","openApiOperationId":"listEntitlements","summary":"List entitlements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlements","exampleIds":["paths/~1v3~1entitlements/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/entitlements","exampleIds":["paths/~1v3~1entitlements/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1entitlements/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/entitlements","exampleIds":["paths/~1v3~1entitlements/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlements","exampleIds":["paths/~1v3~1entitlements/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlement/listentitlements"}],"panels":[]}]},"httpPath":"/v3/entitlements"},{"label":"Create entitlements","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/entitlement/createentitlements","routeSlug":"/zephr-api-reference/zephr-admin-api/entitlement/createentitlements","metadata":{"seo":{"title":"Create entitlements","description":"Creates entitlements."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEntitlements","name":"Create entitlements","isWebhook":false,"pointer":"/paths/~1v3~1entitlements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create entitlements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates entitlements."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_20"}},"schemaId":"schema_20","pointer":"/paths/~1v3~1entitlements/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/entitlements","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_20"}},"responseCodes":["201","400"],"pointer":"/v3/entitlements","href":"entitlement/createentitlements","openApiOperationId":"createEntitlements","summary":"Create entitlements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_20","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_20"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1entitlements/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlement/createentitlements"}],"panels":[]}]},"httpPath":"/v3/entitlements"},{"label":"Create an entitlement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/entitlement/createentitlement","routeSlug":"/zephr-api-reference/zephr-admin-api/entitlement/createentitlement","metadata":{"seo":{"title":"Create an entitlement","description":"Creates an entitlement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEntitlement","name":"Create an entitlement","isWebhook":false,"pointer":"/paths/~1v3~1entitlements~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an entitlement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an entitlement."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Entitlement identifier","required":true}],"pointer":"/paths/~1v3~1entitlements~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_20"}},"schemaId":"schema_20","pointer":"/paths/~1v3~1entitlements~1{id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/entitlements/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_20"}},"responseCodes":["201","400"],"pointer":"/v3/entitlements/{id}","href":"entitlement/createentitlement","openApiOperationId":"createEntitlement","summary":"Create an entitlement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_20","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_20"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1entitlements~1{id}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlement/createentitlement"}],"panels":[]}]},"httpPath":"/v3/entitlements/{id}"},{"label":"Retrieve an entitlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/entitlement/getentitlement","routeSlug":"/zephr-api-reference/zephr-admin-api/entitlement/getentitlement","metadata":{"seo":{"title":"Retrieve an entitlement","description":"Retrieves a single entitlement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntitlement","name":"Retrieve an entitlement","isWebhook":false,"pointer":"/paths/~1v3~1entitlements~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an entitlement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single entitlement."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Entitlement identifier","required":true}],"pointer":"/paths/~1v3~1entitlements~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/entitlements/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/entitlements/{id}","href":"entitlement/getentitlement","openApiOperationId":"getEntitlement","summary":"Retrieve an entitlement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement","exampleIds":["paths/~1v3~1entitlements~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/entitlement","exampleIds":["paths/~1v3~1entitlements~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1entitlements~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/entitlement","exampleIds":["paths/~1v3~1entitlements~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement","exampleIds":["paths/~1v3~1entitlements~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlement/getentitlement"}],"panels":[]}]},"httpPath":"/v3/entitlements/{id}"},{"label":"Delete an entitlement","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/entitlement/deleteentitlement","routeSlug":"/zephr-api-reference/zephr-admin-api/entitlement/deleteentitlement","metadata":{"seo":{"title":"Delete an entitlement","description":"Deletes an entitlement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEntitlement","name":"Delete an entitlement","isWebhook":false,"pointer":"/paths/~1v3~1entitlements~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an entitlement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an entitlement."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Entitlement identifier","required":true}],"pointer":"/paths/~1v3~1entitlements~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/entitlements/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/entitlements/{id}","href":"entitlement/deleteentitlement","openApiOperationId":"deleteEntitlement","summary":"Delete an entitlement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1entitlements~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlement/deleteentitlement"}],"panels":[]}]},"httpPath":"/v3/entitlements/{id}"}],"content":{"contentType":"group","meta":{"name":"Entitlement"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Entitlement","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Entitlement."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/entitlements","summary":"List entitlements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlement/listentitlements","deprecated":false},{"title":"/v3/entitlements","summary":"Create entitlements","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entitlement/createentitlements","deprecated":false},{"title":"/v3/entitlements/{id}","summary":"Create an entitlement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entitlement/createentitlement","deprecated":false},{"title":"/v3/entitlements/{id}","summary":"Retrieve an entitlement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlement/getentitlement","deprecated":false},{"title":"/v3/entitlements/{id}","summary":"Delete an entitlement","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/entitlement/deleteentitlement","deprecated":false}]}]}]}]}},{"type":"group","label":"Feature Rules","link":"/zephr-api-reference/zephr-admin-api/feature-rules","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules","items":[{"label":"List feature rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/feature-rules/listfeaturerules","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules/listfeaturerules","metadata":{"seo":{"title":"List feature rules","description":"Retrieves a list of feature rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFeatureRules","name":"List feature rules","isWebhook":false,"pointer":"/paths/~1v3~1feature-rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List feature rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of feature rules."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tags","in":"query","schemaId":"schema_21","description":"A comma-separeted list of feature rule tags (Maximum 50 tags allowed)"}],"pointer":"/paths/~1v3~1feature-rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/feature-rules","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[{"name":"tags","in":"query","example":"tag1,tag2,tag3","schemaId":"schema_21"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/feature-rules","href":"feature-rules/listfeaturerules","openApiOperationId":"listFeatureRules","summary":"List feature rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Feature rules have been retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/feature_rules_response","exampleIds":["paths/~1v3~1feature-rules/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/feature_rules_response","exampleIds":["paths/~1v3~1feature-rules/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request - Tags size exceeded the limit of 50","headers":{}}],"pointer":"/paths/~1v3~1feature-rules/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/feature_rules_response","exampleIds":["paths/~1v3~1feature-rules/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/feature_rules_response","exampleIds":["paths/~1v3~1feature-rules/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feature-rules/listfeaturerules"}],"panels":[]}]},"httpPath":"/v3/feature-rules"},{"label":"Delete a feature rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/feature-rules/deletefeaturerule","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules/deletefeaturerule","metadata":{"seo":{"title":"Delete a feature rule","description":"Deletes a feature rule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFeatureRule","name":"Delete a feature rule","isWebhook":false,"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a feature rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a feature rule."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"featureRuleId","in":"path","schemaId":"schema_0","description":"Unique Feature Rule identifier","required":true}],"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/feature-rules/{featureRuleId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"featureRuleId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/feature-rules/{featureRuleId}","href":"feature-rules/deletefeaturerule","openApiOperationId":"deleteFeatureRule","summary":"Delete a feature rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/feature_rule_deletion_response"}},"schemaId":"components/schemas/feature_rule_deletion_response","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/feature_rule_deletion_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/feature_rule_deletion_response"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feature-rules/deletefeaturerule"}],"panels":[]}]},"httpPath":"/v3/feature-rules/{featureRuleId}"},{"label":"List the versions of a feature rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/feature-rules/getfeatureruleversions","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules/getfeatureruleversions","metadata":{"seo":{"title":"List the versions of a feature rule","description":"Retrieves a lists of all the versions for a single feature rule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFeatureRuleVersions","name":"List the versions of a feature rule","isWebhook":false,"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the versions of a feature rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a lists of all the versions for a single feature rule."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"featureRuleId","in":"path","schemaId":"schema_0","description":"Unique Feature Rule identifier","required":true}],"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/feature-rules/{featureRuleId}/versions","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"featureRuleId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/feature-rules/{featureRuleId}/versions","href":"feature-rules/getfeatureruleversions","openApiOperationId":"getFeatureRuleVersions","summary":"List the versions of a feature rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/feature_rules_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/feature_rules_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/feature_rules_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/feature_rules_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feature-rules/getfeatureruleversions"}],"panels":[]}]},"httpPath":"/v3/feature-rules/{featureRuleId}/versions"},{"label":"Create a feature rule version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/feature-rules/createfeaturerule","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules/createfeaturerule","metadata":{"seo":{"title":"Create a feature rule version","description":"Creates a feature rule version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFeatureRule","name":"Create a feature rule version","isWebhook":false,"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a feature rule version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a feature rule version."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"featureRuleId","in":"path","schemaId":"schema_0","description":"Unique Feature Rule identifier","required":true}],"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22","pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/feature-rules/{featureRuleId}/versions","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"featureRuleId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_22"}},"responseCodes":["200","201","400"],"pointer":"/v3/feature-rules/{featureRuleId}/versions","href":"feature-rules/createfeaturerule","openApiOperationId":"createFeatureRule","summary":"Create a feature rule version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/feature_rule_creation_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/feature_rule_creation_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions/post/responses/201/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"201","schemaId":"components/schemas/feature_rule_creation_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/feature_rule_creation_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions/post/responses/201/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feature-rules/createfeaturerule"}],"panels":[]}]},"httpPath":"/v3/feature-rules/{featureRuleId}/versions"},{"label":"Retrieve a feature rule version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/feature-rules/getfeatureruleversion","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules/getfeatureruleversion","metadata":{"seo":{"title":"Retrieve a feature rule version","description":"Retrieves a version for a single feature rule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFeatureRuleVersion","name":"Retrieve a feature rule version","isWebhook":false,"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a feature rule version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a version for a single feature rule."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"featureRuleId","in":"path","schemaId":"schema_0","description":"Unique Feature Rule identifier","required":true},{"name":"versionId","in":"path","schemaId":"schema_0","description":"Unique Version identifier","required":true}],"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/feature-rules/{featureRuleId}/versions/{versionId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"featureRuleId","in":"path","required":true,"schemaId":"schema_0"},{"name":"versionId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/feature-rules/{featureRuleId}/versions/{versionId}","href":"feature-rules/getfeatureruleversion","openApiOperationId":"getFeatureRuleVersion","summary":"Retrieve a feature rule version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/feature_rule_version_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/feature_rule_version_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/feature_rule_version_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/feature_rule_version_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feature-rules/getfeatureruleversion"}],"panels":[]}]},"httpPath":"/v3/feature-rules/{featureRuleId}/versions/{versionId}"},{"label":"Delete a feature rule version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/feature-rules/deletefeatureruleversion","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules/deletefeatureruleversion","metadata":{"seo":{"title":"Delete a feature rule version","description":"Deletes a single version of a feature rule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFeatureRuleVersion","name":"Delete a feature rule version","isWebhook":false,"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a feature rule version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a single version of a feature rule."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"featureRuleId","in":"path","schemaId":"schema_0","description":"Unique Feature Rule identifier","required":true},{"name":"versionId","in":"path","schemaId":"schema_0","description":"Unique Version identifier","required":true}],"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/feature-rules/{featureRuleId}/versions/{versionId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"featureRuleId","in":"path","required":true,"schemaId":"schema_0"},{"name":"versionId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/feature-rules/{featureRuleId}/versions/{versionId}","href":"feature-rules/deletefeatureruleversion","openApiOperationId":"deleteFeatureRuleVersion","summary":"Delete a feature rule version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/feature_rule_deletion_response"}},"schemaId":"components/schemas/feature_rule_deletion_response","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/feature_rule_deletion_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/feature_rule_deletion_response"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feature-rules/deletefeatureruleversion"}],"panels":[]}]},"httpPath":"/v3/feature-rules/{featureRuleId}/versions/{versionId}"},{"label":"Save feature rule version tags","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/feature-rules/savefeaturerule","routeSlug":"/zephr-api-reference/zephr-admin-api/feature-rules/savefeaturerule","metadata":{"seo":{"title":"Save feature rule version tags","description":"Saves the feature rule version tags."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"saveFeatureRule","name":"Save feature rule version tags","isWebhook":false,"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}~1tags/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Save feature rule version tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Saves the feature rule version tags."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"featureRuleId","in":"path","schemaId":"schema_0","description":"Unique Feature Rule identifier","required":true},{"name":"versionId","in":"path","schemaId":"schema_0","description":"Unique Version identifier","required":true}],"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}~1tags/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_23"}},"schemaId":"schema_23","pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}~1tags/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/feature-rules/{featureRuleId}/versions/{versionId}/tags","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"featureRuleId","in":"path","required":true,"schemaId":"schema_0"},{"name":"versionId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_23"}},"responseCodes":["200","201","400"],"pointer":"/v3/feature-rules/{featureRuleId}/versions/{versionId}/tags","href":"feature-rules/savefeaturerule","openApiOperationId":"saveFeatureRule","summary":"Save feature rule version tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_23","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_23"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/feature_rule_version_tags_update_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}~1tags/put/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/feature_rule_version_tags_update_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}~1tags/put/responses/201/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}~1tags/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"201","schemaId":"components/schemas/feature_rule_version_tags_update_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}~1tags/put/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/feature_rule_version_tags_update_response","exampleIds":["paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}~1tags/put/responses/201/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feature-rules/savefeaturerule"}],"panels":[]}]},"httpPath":"/v3/feature-rules/{featureRuleId}/versions/{versionId}/tags"}],"content":{"contentType":"group","meta":{"name":"Feature Rules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Feature Rules","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Feature Rules."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/feature-rules","summary":"List feature rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feature-rules/listfeaturerules","deprecated":false},{"title":"/v3/feature-rules/{featureRuleId}","summary":"Delete a feature rule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/feature-rules/deletefeaturerule","deprecated":false},{"title":"/v3/feature-rules/{featureRuleId}/versions","summary":"List the versions of a feature rule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feature-rules/getfeatureruleversions","deprecated":false},{"title":"/v3/feature-rules/{featureRuleId}/versions","summary":"Create a feature rule version","prefix":{"name":"post","color":"post"},"badges":[],"link":"/feature-rules/createfeaturerule","deprecated":false},{"title":"/v3/feature-rules/{featureRuleId}/versions/{versionId}","summary":"Retrieve a feature rule version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feature-rules/getfeatureruleversion","deprecated":false},{"title":"/v3/feature-rules/{featureRuleId}/versions/{versionId}","summary":"Delete a feature rule version","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/feature-rules/deletefeatureruleversion","deprecated":false},{"title":"/v3/feature-rules/{featureRuleId}/versions/{versionId}/tags","summary":"Save feature rule version tags","prefix":{"name":"put","color":"put"},"badges":[],"link":"/feature-rules/savefeaturerule","deprecated":false}]}]}]}]}},{"type":"group","label":"Form","link":"/zephr-api-reference/zephr-admin-api/form","routeSlug":"/zephr-api-reference/zephr-admin-api/form","items":[{"label":"List forms","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/form/listforms","routeSlug":"/zephr-api-reference/zephr-admin-api/form/listforms","metadata":{"seo":{"title":"List forms","description":"Retrieves a list of forms wrapped in the element \"results\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listForms","name":"List forms","isWebhook":false,"pointer":"/paths/~1v3~1forms/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List forms","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of forms wrapped in the element \"results\"."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/forms","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/forms","href":"form/listforms","openApiOperationId":"listForms","summary":"List forms"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/forms","exampleIds":["paths/~1v3~1forms/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/forms","exampleIds":["paths/~1v3~1forms/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1forms/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/forms","exampleIds":["paths/~1v3~1forms/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/forms","exampleIds":["paths/~1v3~1forms/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form/listforms"}],"panels":[]}]},"httpPath":"/v3/forms"},{"label":"Retrieve Form","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/form/getform","routeSlug":"/zephr-api-reference/zephr-admin-api/form/getform","metadata":{"seo":{"title":"Retrieve Form","description":"Retrieves a single form."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getForm","name":"Retrieve Form","isWebhook":false,"pointer":"/paths/~1v3~1forms~1{slug}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Form","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single form."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"slug","in":"path","schemaId":"schema_0","description":"Unique Form identifier","required":true}],"pointer":"/paths/~1v3~1forms~1{slug}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/forms/{slug}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"slug","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/forms/{slug}","href":"form/getform","openApiOperationId":"getForm","summary":"Retrieve Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/form","exampleIds":["paths/~1v3~1forms~1{slug}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/form","exampleIds":["paths/~1v3~1forms~1{slug}/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1forms~1{slug}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/form","exampleIds":["paths/~1v3~1forms~1{slug}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/form","exampleIds":["paths/~1v3~1forms~1{slug}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form/getform"}],"panels":[]}]},"httpPath":"/v3/forms/{slug}"},{"label":"Delete a form","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/form/deleteform","routeSlug":"/zephr-api-reference/zephr-admin-api/form/deleteform","metadata":{"seo":{"title":"Delete a form","description":"Deletes a form."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteForm","name":"Delete a form","isWebhook":false,"pointer":"/paths/~1v3~1forms~1{slug}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a form","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a form."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"slug","in":"path","schemaId":"schema_0","description":"Unique Form identifier","required":true}],"pointer":"/paths/~1v3~1forms~1{slug}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/forms/{slug}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"slug","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/forms/{slug}","href":"form/deleteform","openApiOperationId":"deleteForm","summary":"Delete a form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1forms~1{slug}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form/deleteform"}],"panels":[]}]},"httpPath":"/v3/forms/{slug}"},{"label":"Save a form","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/form/saveform","routeSlug":"/zephr-api-reference/zephr-admin-api/form/saveform","metadata":{"seo":{"title":"Save a form","description":"Saves a form."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"saveForm","name":"Save a form","isWebhook":false,"pointer":"/paths/~1v3~1forms~1{slug}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Save a form","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Saves a form."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"slug","in":"path","schemaId":"schema_0","description":"Unique Form identifier","required":true}],"pointer":"/paths/~1v3~1forms~1{slug}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24","pointer":"/paths/~1v3~1forms~1{slug}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/forms/{slug}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"slug","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_24"}},"responseCodes":["200","201","400"],"pointer":"/v3/forms/{slug}","href":"form/saveform","openApiOperationId":"saveForm","summary":"Save a form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1forms~1{slug}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form/saveform"}],"panels":[]}]},"httpPath":"/v3/forms/{slug}"}],"content":{"contentType":"group","meta":{"name":"Form"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Form","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Form."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/forms","summary":"List forms","prefix":{"name":"get","color":"get"},"badges":[],"link":"/form/listforms","deprecated":false},{"title":"/v3/forms/{slug}","summary":"Retrieve Form","prefix":{"name":"get","color":"get"},"badges":[],"link":"/form/getform","deprecated":false},{"title":"/v3/forms/{slug}","summary":"Delete a form","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/form/deleteform","deprecated":false},{"title":"/v3/forms/{slug}","summary":"Save a form","prefix":{"name":"put","color":"put"},"badges":[],"link":"/form/saveform","deprecated":false}]}]}]}]}},{"type":"group","label":"Gifts","link":"/zephr-api-reference/zephr-admin-api/gifts","routeSlug":"/zephr-api-reference/zephr-admin-api/gifts","items":[{"label":"List all the unclaimed gifts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/gifts/listallunclaimedgifts","routeSlug":"/zephr-api-reference/zephr-admin-api/gifts/listallunclaimedgifts","metadata":{"seo":{"title":"List all the unclaimed gifts","description":"Lists all the unclaimed gifts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAllUnclaimedGifts","name":"List all the unclaimed gifts","isWebhook":false,"pointer":"/paths/~1v3~1gift/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all the unclaimed gifts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all the unclaimed gifts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/gift","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/gift","href":"gifts/listallunclaimedgifts","openApiOperationId":"listAllUnclaimedGifts","summary":"List all the unclaimed gifts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/gifts","exampleIds":["paths/~1v3~1gift/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/gifts","exampleIds":["paths/~1v3~1gift/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1gift/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/gifts","exampleIds":["paths/~1v3~1gift/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/gifts","exampleIds":["paths/~1v3~1gift/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/listallunclaimedgifts"}],"panels":[]}]},"httpPath":"/v3/gift"},{"label":"Create a gift","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/gifts/creategift","routeSlug":"/zephr-api-reference/zephr-admin-api/gifts/creategift","metadata":{"seo":{"title":"Create a gift","description":"Creates a gift."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGift","name":"Create a gift","isWebhook":false,"pointer":"/paths/~1v3~1gift/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a gift","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a gift."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25","pointer":"/paths/~1v3~1gift/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/gift","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_25"}},"responseCodes":["200"],"pointer":"/v3/gift","href":"gifts/creategift","openApiOperationId":"createGift","summary":"Create a gift"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_25"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_26"}},"schemaId":"schema_26","headers":{}}],"pointer":"/paths/~1v3~1gift/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_26","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_26"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/creategift"}],"panels":[]}]},"httpPath":"/v3/gift"},{"label":"Delete a gift","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/gifts/deletegift","routeSlug":"/zephr-api-reference/zephr-admin-api/gifts/deletegift","metadata":{"seo":{"title":"Delete a gift","description":"Deletes a gift."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGift","name":"Delete a gift","isWebhook":false,"pointer":"/paths/~1v3~1gift~1{giftId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a gift","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a gift."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"giftId","in":"path","schemaId":"schema_0","description":"","required":true,"example":"469efefbe4c4cae0"}],"pointer":"/paths/~1v3~1gift~1{giftId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/gift/{giftId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"giftId","in":"path","required":true,"example":"469efefbe4c4cae0","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/gift/{giftId}","href":"gifts/deletegift","openApiOperationId":"deleteGift","summary":"Delete a gift"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1gift~1{giftId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/deletegift"}],"panels":[]}]},"httpPath":"/v3/gift/{giftId}"}],"content":{"contentType":"group","meta":{"name":"Gifts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gifts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/gift","summary":"List all the unclaimed gifts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gifts/listallunclaimedgifts","deprecated":false},{"title":"/v3/gift","summary":"Create a gift","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gifts/creategift","deprecated":false},{"title":"/v3/gift/{giftId}","summary":"Delete a gift","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/gifts/deletegift","deprecated":false}]}]}]}]}},{"type":"group","label":"Grants","link":"/zephr-api-reference/zephr-admin-api/grants","routeSlug":"/zephr-api-reference/zephr-admin-api/grants","items":[{"label":"List user grants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/listusergrants","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/listusergrants","metadata":{"seo":{"title":"List user grants","description":"Retrieves a list of user grants."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserGrants","name":"List user grants","isWebhook":false,"pointer":"/paths/~1v3~1users~1{userId}~1grants/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user grants","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of user grants."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1users~1{userId}~1grants/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"active","in":"query","schemaId":"schema_27","description":"Whether or not to include only active grants","example":"true"}],"pointer":"/paths/~1v3~1users~1{userId}~1grants/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/users/{userId}/grants","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"active","in":"query","required":false,"example":"true","schemaId":"schema_27"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/users/{userId}/grants","href":"grants/listusergrants","openApiOperationId":"listUserGrants","summary":"List user grants"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a list of grants for the user","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1v3~1users~1{userId}~1grants/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_28","exampleIds":["paths/~1v3~1users~1{userId}~1grants/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"401","description":"Unauthorized","headers":{}}],"pointer":"/paths/~1v3~1users~1{userId}~1grants/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_28","exampleIds":["paths/~1v3~1users~1{userId}~1grants/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1v3~1users~1{userId}~1grants/get/responses/200/content/application~1json/examples/response"]}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/grants/listusergrants"}],"panels":[]}]},"httpPath":"/v3/users/{userId}/grants"},{"label":"Create a grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/creategrants","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/creategrants","metadata":{"seo":{"title":"Create a grant","description":"Creates a user grant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGrants","name":"Create a grant","isWebhook":false,"pointer":"/paths/~1v3~1users~1{userId}~1grants/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a grant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a user grant."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1users~1{userId}~1grants/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"}},"schemaId":"schema_29","pointer":"/paths/~1v3~1users~1{userId}~1grants/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/users/{userId}/grants","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_29"}},"responseCodes":["201","400","403","409"],"pointer":"/v3/users/{userId}/grants","href":"grants/creategrants","openApiOperationId":"createGrants","summary":"Create a grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_29","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}},{"code":"403","description":"Forbidden. You need one of the following privileges to access this endpoint: Identity Module, Products Module, B2B Module or Journey Module"},{"code":"409","description":"The user does not exist","headers":{}}],"pointer":"/paths/~1v3~1users~1{userId}~1grants/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/grants/creategrants"}],"panels":[]}]},"httpPath":"/v3/users/{userId}/grants"},{"label":"Retrieve a grant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/getaccountgrant","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/getaccountgrant","metadata":{"seo":{"title":"Retrieve a grant","description":"Retrieves a single grant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountGrant","name":"Retrieve a grant","isWebhook":false,"pointer":"/paths/~1v3~1users~1{userId}~1grants~1{grantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a grant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single grant."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true},{"name":"grantId","in":"path","schemaId":"schema_0","description":"Unique Grant identifier","required":true}],"pointer":"/paths/~1v3~1users~1{userId}~1grants~1{grantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/users/{userId}/grants/{grantId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_0"},{"name":"grantId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/users/{userId}/grants/{grantId}","href":"grants/getaccountgrant","openApiOperationId":"getAccountGrant","summary":"Retrieve a grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/grant"}},"schemaId":"components/schemas/grant","headers":{}}],"pointer":"/paths/~1v3~1users~1{userId}~1grants~1{grantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/grant","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/grant"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/grants/getaccountgrant"}],"panels":[]}]},"httpPath":"/v3/users/{userId}/grants/{grantId}"},{"label":"Delete a grant","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/deleteusergrant","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/deleteusergrant","metadata":{"seo":{"title":"Delete a grant","description":"Deletes a grant specified by the grantId. This is for a user that is specified by the userId"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUserGrant","name":"Delete a grant","isWebhook":false,"pointer":"/paths/~1v3~1users~1{userId}~1grants~1{grantId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a grant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a grant specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is for a user that is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userId"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true,"example":"3f589a2d-86ad-4b70-a5df-68dca75a3a21"},{"name":"grantId","in":"path","schemaId":"schema_0","description":"Unique Grant identifier","required":true,"example":"5fag4a2d-86cd-4bb0-a5df-68dca75a3a21"}],"pointer":"/paths/~1v3~1users~1{userId}~1grants~1{grantId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/users/{userId}/grants/{grantId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":"3f589a2d-86ad-4b70-a5df-68dca75a3a21","schemaId":"schema_0"},{"name":"grantId","in":"path","required":true,"example":"5fag4a2d-86cd-4bb0-a5df-68dca75a3a21","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/users/{userId}/grants/{grantId}","href":"grants/deleteusergrant","openApiOperationId":"deleteUserGrant","summary":"Delete a grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - The grant was found and successfully deleted","headers":{}},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found - Cannot find an existing grant for the supplied "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantId"},"children":[]}]}]}],"headers":{}}],"pointer":"/paths/~1v3~1users~1{userId}~1grants~1{grantId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/grants/deleteusergrant"}],"panels":[]}]},"httpPath":"/v3/users/{userId}/grants/{grantId}"},{"label":"Create an account grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/creategrant","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/creategrant","metadata":{"seo":{"title":"Create an account grant","description":"Creates an account grant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGrant","name":"Create an account grant","isWebhook":false,"pointer":"/paths/~1v3~1users~1{userId}~1grants~1{grantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an account grant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an account grant."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true},{"name":"grantId","in":"path","schemaId":"schema_0","description":"Unique Grant identifier","required":true}],"pointer":"/paths/~1v3~1users~1{userId}~1grants~1{grantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"}},"schemaId":"schema_29","pointer":"/paths/~1v3~1users~1{userId}~1grants~1{grantId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/users/{userId}/grants/{grantId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_0"},{"name":"grantId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_29"}},"responseCodes":["201","400"],"pointer":"/v3/users/{userId}/grants/{grantId}","href":"grants/creategrant","openApiOperationId":"createGrant","summary":"Create an account grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_29","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1users~1{userId}~1grants~1{grantId}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/grants/creategrant"}],"panels":[]}]},"httpPath":"/v3/users/{userId}/grants/{grantId}"},{"label":"Retrieve a user access model","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/retrieveuseraccessmodel","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/retrieveuseraccessmodel","metadata":{"seo":{"title":"Retrieve a user access model","description":"Retrieves a user access model."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveUserAccessModel","name":"Retrieve a user access model","isWebhook":false,"pointer":"/paths/~1v3~1users~1{userId}~1accessModel/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a user access model","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a user access model."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1users~1{userId}~1accessModel/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/users/{userId}/accessModel","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/users/{userId}/accessModel","href":"grants/retrieveuseraccessmodel","openApiOperationId":"retrieveUserAccessModel","summary":"Retrieve a user access model"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/access_model","exampleIds":["paths/~1v3~1users~1{userId}~1accessModel/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/access_model","exampleIds":["paths/~1v3~1users~1{userId}~1accessModel/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1users~1{userId}~1accessModel/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/access_model","exampleIds":["paths/~1v3~1users~1{userId}~1accessModel/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/access_model","exampleIds":["paths/~1v3~1users~1{userId}~1accessModel/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/grants/retrieveuseraccessmodel"}],"panels":[]}]},"httpPath":"/v3/users/{userId}/accessModel"},{"label":"List account grants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/listaccountgrants","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/listaccountgrants","metadata":{"seo":{"title":"List account grants","description":"Retrieves a list of account grants."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAccountGrants","name":"List account grants","isWebhook":false,"pointer":"/paths/~1v3~1accounts~1{accountId}~1grants/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List account grants","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of account grants."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_0","description":"Unique Account identifier","required":true}],"pointer":"/paths/~1v3~1accounts~1{accountId}~1grants/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/accounts/{accountId}/grants","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/accounts/{accountId}/grants","href":"grants/listaccountgrants","openApiOperationId":"listAccountGrants","summary":"List account grants"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}},"schemaId":"schema_30","headers":{}}],"pointer":"/paths/~1v3~1accounts~1{accountId}~1grants/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_30","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/grants/listaccountgrants"}],"panels":[]}]},"httpPath":"/v3/accounts/{accountId}/grants"},{"label":"Create an account grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/createaccountgrant","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/createaccountgrant","metadata":{"seo":{"title":"Create an account grant","description":"Creates an account grant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAccountGrant","name":"Create an account grant","isWebhook":false,"pointer":"/paths/~1v3~1accounts~1{accountId}~1grants/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an account grant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an account grant."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_0","description":"Unique Account identifier","required":true}],"pointer":"/paths/~1v3~1accounts~1{accountId}~1grants/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"}},"schemaId":"schema_29","pointer":"/paths/~1v3~1accounts~1{accountId}~1grants/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/accounts/{accountId}/grants","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_29"}},"responseCodes":["201","400"],"pointer":"/v3/accounts/{accountId}/grants","href":"grants/createaccountgrant","openApiOperationId":"createAccountGrant","summary":"Create an account grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_29","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1accounts~1{accountId}~1grants/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/grants/createaccountgrant"}],"panels":[]}]},"httpPath":"/v3/accounts/{accountId}/grants"},{"label":"Retrieve an account grant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/getusergrant","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/getusergrant","metadata":{"seo":{"title":"Retrieve an account grant","description":"Retrieves a single account grant information, if the supplied accountId and grantId match"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserGrant","name":"Retrieve an account grant","isWebhook":false,"pointer":"/paths/~1v3~1accounts~1{accountId}~1grants~1{grantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an account grant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a single account grant information, if the supplied "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_0","description":"Unique Account identifier","required":true,"example":"5fag4a2d-86cd-4bb0-a5df-68dca75a3a21"},{"name":"grantId","in":"path","schemaId":"schema_0","description":"Unique Grant identifier","required":true,"example":"0123456789ABCD"}],"pointer":"/paths/~1v3~1accounts~1{accountId}~1grants~1{grantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/accounts/{accountId}/grants/{grantId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"example":"5fag4a2d-86cd-4bb0-a5df-68dca75a3a21","schemaId":"schema_0"},{"name":"grantId","in":"path","required":true,"example":"0123456789ABCD","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/accounts/{accountId}/grants/{grantId}","href":"grants/getusergrant","openApiOperationId":"getUserGrant","summary":"Retrieve an account grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Retrieved an account grant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/grant-response","exampleIds":["paths/~1v3~1accounts~1{accountId}~1grants~1{grantId}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/grant-response","exampleIds":["paths/~1v3~1accounts~1{accountId}~1grants~1{grantId}/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT FOUND - Cannot find an existing grant information for the supplied "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantId"},"children":[]}]}]}],"headers":{}}],"pointer":"/paths/~1v3~1accounts~1{accountId}~1grants~1{grantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/grant-response","exampleIds":["paths/~1v3~1accounts~1{accountId}~1grants~1{grantId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/grant-response","exampleIds":["paths/~1v3~1accounts~1{accountId}~1grants~1{grantId}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/grants/getusergrant"}],"panels":[]}]},"httpPath":"/v3/accounts/{accountId}/grants/{grantId}"},{"label":"Delete an account grant","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/deleteaccountgrantbyid","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/deleteaccountgrantbyid","metadata":{"seo":{"title":"Delete an account grant","description":"Deletes an account grant specified by the grantId. This is for a user that is specified by the accountId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAccountGrantById","name":"Delete an account grant","isWebhook":false,"pointer":"/paths/~1v3~1accounts~1{accountId}~1grants~1{grantId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an account grant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an account grant specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is for a user that is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_0","description":"Unique Account identifier","required":true,"example":"3f589a2d-86ad-4b70-a5df-68dca75a3a21"},{"name":"grantId","in":"path","schemaId":"schema_0","description":"Unique Grant identifier","required":true,"example":"5fag4a2d-86cd-4bb0-a5df-68dca75a3a21"}],"pointer":"/paths/~1v3~1accounts~1{accountId}~1grants~1{grantId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/accounts/{accountId}/grants/{grantId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"example":"3f589a2d-86ad-4b70-a5df-68dca75a3a21","schemaId":"schema_0"},{"name":"grantId","in":"path","required":true,"example":"5fag4a2d-86cd-4bb0-a5df-68dca75a3a21","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/accounts/{accountId}/grants/{grantId}","href":"grants/deleteaccountgrantbyid","openApiOperationId":"deleteAccountGrantById","summary":"Delete an account grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - The grant was found and successfully deleted","headers":{}},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found - Cannot find an existing grant for the supplied "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantId"},"children":[]}]}]}],"headers":{}}],"pointer":"/paths/~1v3~1accounts~1{accountId}~1grants~1{grantId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/grants/deleteaccountgrantbyid"}],"panels":[]}]},"httpPath":"/v3/accounts/{accountId}/grants/{grantId}"},{"label":"Create an account grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/createaccountgrantv4","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/createaccountgrantv4","metadata":{"seo":{"title":"Create an account grant","description":"Creates an account grant. This is for an account that is specified by the accountId"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAccountGrantV4","name":"Create an account grant","isWebhook":false,"pointer":"/paths/~1v4~1accounts~1{accountId}~1grants/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an account grant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an account grant. This is for an account that is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_0","description":"Unique Account identifier","required":true}],"pointer":"/paths/~1v4~1accounts~1{accountId}~1grants/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"}},"schemaId":"schema_29","pointer":"/paths/~1v4~1accounts~1{accountId}~1grants/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/accounts/{accountId}/grants","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_29"}},"responseCodes":["201","400"],"pointer":"/v4/accounts/{accountId}/grants","href":"grants/createaccountgrantv4","openApiOperationId":"createAccountGrantV4","summary":"Create an account grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_29","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v4~1accounts~1{accountId}~1grants/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/grants/createaccountgrantv4"}],"panels":[]}]},"httpPath":"/v4/accounts/{accountId}/grants"},{"label":"Delete an account grant","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/grants/deleteaccountgrant","routeSlug":"/zephr-api-reference/zephr-admin-api/grants/deleteaccountgrant","metadata":{"seo":{"title":"Delete an account grant","description":"Deletes an account grant specified by the grantId. This is for a user that is specified by the accountId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAccountGrant","name":"Delete an account grant","isWebhook":false,"pointer":"/paths/~1v4~1accounts~1{accountId}~1grants~1{grantId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an account grant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an account grant specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is for a user that is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_0","description":"Unique Account identifier","required":true,"example":"3f589a2d-86ad-4b70-a5df-68dca75a3a21"},{"name":"grantId","in":"path","schemaId":"schema_0","description":"Unique Grant identifier","required":true,"example":"5fag4a2d-86cd-4bb0-a5df-68dca75a3a21"}],"pointer":"/paths/~1v4~1accounts~1{accountId}~1grants~1{grantId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/accounts/{accountId}/grants/{grantId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"example":"3f589a2d-86ad-4b70-a5df-68dca75a3a21","schemaId":"schema_0"},{"name":"grantId","in":"path","required":true,"example":"5fag4a2d-86cd-4bb0-a5df-68dca75a3a21","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/accounts/{accountId}/grants/{grantId}","href":"grants/deleteaccountgrant","openApiOperationId":"deleteAccountGrant","summary":"Delete an account grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - The grant was found and successfully deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v4~1accounts~1{accountId}~1grants~1{grantId}/delete/responses/200/content/application~1json/examples/response"]}},"exampleIds":["paths/~1v4~1accounts~1{accountId}~1grants~1{grantId}/delete/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found - Cannot find an existing grant for the supplied "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantId"},"children":[]}]}]}],"headers":{}}],"pointer":"/paths/~1v4~1accounts~1{accountId}~1grants~1{grantId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v4~1accounts~1{accountId}~1grants~1{grantId}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v4~1accounts~1{accountId}~1grants~1{grantId}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/grants/deleteaccountgrant"}],"panels":[]}]},"httpPath":"/v4/accounts/{accountId}/grants/{grantId}"}],"content":{"contentType":"group","meta":{"name":"Grants"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Grants","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Grant."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/users/{userId}/grants","summary":"List user grants","prefix":{"name":"get","color":"get"},"badges":[],"link":"/grants/listusergrants","deprecated":false},{"title":"/v3/users/{userId}/grants","summary":"Create a grant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/grants/creategrants","deprecated":false},{"title":"/v3/users/{userId}/grants/{grantId}","summary":"Retrieve a grant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/grants/getaccountgrant","deprecated":false},{"title":"/v3/users/{userId}/grants/{grantId}","summary":"Delete a grant","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/grants/deleteusergrant","deprecated":false},{"title":"/v3/users/{userId}/grants/{grantId}","summary":"Create an account grant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/grants/creategrant","deprecated":false},{"title":"/v3/users/{userId}/accessModel","summary":"Retrieve a user access model","prefix":{"name":"get","color":"get"},"badges":[],"link":"/grants/retrieveuseraccessmodel","deprecated":false},{"title":"/v3/accounts/{accountId}/grants","summary":"List account grants","prefix":{"name":"get","color":"get"},"badges":[],"link":"/grants/listaccountgrants","deprecated":false},{"title":"/v3/accounts/{accountId}/grants","summary":"Create an account grant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/grants/createaccountgrant","deprecated":false},{"title":"/v3/accounts/{accountId}/grants/{grantId}","summary":"Retrieve an account grant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/grants/getusergrant","deprecated":false},{"title":"/v3/accounts/{accountId}/grants/{grantId}","summary":"Delete an account grant","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/grants/deleteaccountgrantbyid","deprecated":false},{"title":"/v4/accounts/{accountId}/grants","summary":"Create an account grant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/grants/createaccountgrantv4","deprecated":false},{"title":"/v4/accounts/{accountId}/grants/{grantId}","summary":"Delete an account grant","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/grants/deleteaccountgrant","deprecated":false}]}]}]}]}},{"type":"group","label":"Meter","link":"/zephr-api-reference/zephr-admin-api/meter","routeSlug":"/zephr-api-reference/zephr-admin-api/meter","items":[{"label":"List meters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/meter/listmeters","routeSlug":"/zephr-api-reference/zephr-admin-api/meter/listmeters","metadata":{"seo":{"title":"List meters","description":"Retrieves a list of meters wrapped in the element \"results\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMeters","name":"List meters","isWebhook":false,"pointer":"/paths/~1v3~1meters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List meters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of meters wrapped in the element \"results\"."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/meters","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/meters","href":"meter/listmeters","openApiOperationId":"listMeters","summary":"List meters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/meters","exampleIds":["paths/~1v3~1meters/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/meters","exampleIds":["paths/~1v3~1meters/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1meters/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/meters","exampleIds":["paths/~1v3~1meters/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/meters","exampleIds":["paths/~1v3~1meters/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meter/listmeters"}],"panels":[]}]},"httpPath":"/v3/meters"},{"label":"Create a meter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/meter/createmeter","routeSlug":"/zephr-api-reference/zephr-admin-api/meter/createmeter","metadata":{"seo":{"title":"Create a meter","description":"Creates or updates a meter for specified id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMeter","name":"Create a meter","isWebhook":false,"pointer":"/paths/~1v3~1meters~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a meter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates or updates a meter for specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Meter identifier","required":true}],"pointer":"/paths/~1v3~1meters~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_31"}},"schemaId":"schema_31","pointer":"/paths/~1v3~1meters~1{id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/meters/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_31"}},"responseCodes":["200","201","400"],"pointer":"/v3/meters/{id}","href":"meter/createmeter","openApiOperationId":"createMeter","summary":"Create a meter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_31"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created successfully","headers":{}},{"code":"201","description":"Updated successfully","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1meters~1{id}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meter/createmeter"}],"panels":[]}]},"httpPath":"/v3/meters/{id}"},{"label":"Retrieve a meter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/meter/getmeter","routeSlug":"/zephr-api-reference/zephr-admin-api/meter/getmeter","metadata":{"seo":{"title":"Retrieve a meter","description":"Retrieves a single meter with specified id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMeter","name":"Retrieve a meter","isWebhook":false,"pointer":"/paths/~1v3~1meters~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a meter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a single meter with specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Meter identifier","required":true}],"pointer":"/paths/~1v3~1meters~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/meters/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/meters/{id}","href":"meter/getmeter","openApiOperationId":"getMeter","summary":"Retrieve a meter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/meter","exampleIds":["paths/~1v3~1meters~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/meter","exampleIds":["paths/~1v3~1meters~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1meters~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/meter","exampleIds":["paths/~1v3~1meters~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/meter","exampleIds":["paths/~1v3~1meters~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meter/getmeter"}],"panels":[]}]},"httpPath":"/v3/meters/{id}"},{"label":"Delete a meter","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/meter/deletemeter","routeSlug":"/zephr-api-reference/zephr-admin-api/meter/deletemeter","metadata":{"seo":{"title":"Delete a meter","description":"Deletes a meter if the meter with id exists."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteMeter","name":"Delete a meter","isWebhook":false,"pointer":"/paths/~1v3~1meters~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a meter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a meter if the meter with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exists."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Meter identifier","required":true,"example":"ad29c8fb-9a4b-428d-98d4-893116ef2afc"}],"pointer":"/paths/~1v3~1meters~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/meters/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"ad29c8fb-9a4b-428d-98d4-893116ef2afc","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/meters/{id}","href":"meter/deletemeter","openApiOperationId":"deleteMeter","summary":"Delete a meter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - meter was deleted successfully","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1meters~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meter/deletemeter"}],"panels":[]}]},"httpPath":"/v3/meters/{id}"}],"content":{"contentType":"group","meta":{"name":"Meter"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Meter","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Meter."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/meters","summary":"List meters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/meter/listmeters","deprecated":false},{"title":"/v3/meters/{id}","summary":"Create a meter","prefix":{"name":"post","color":"post"},"badges":[],"link":"/meter/createmeter","deprecated":false},{"title":"/v3/meters/{id}","summary":"Retrieve a meter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/meter/getmeter","deprecated":false},{"title":"/v3/meters/{id}","summary":"Delete a meter","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/meter/deletemeter","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/zephr-api-reference/zephr-admin-api/products","routeSlug":"/zephr-api-reference/zephr-admin-api/products","items":[{"label":"List products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/products/listproducts","routeSlug":"/zephr-api-reference/zephr-admin-api/products/listproducts","metadata":{"seo":{"title":"List products","description":"Retrieves all configured products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProducts","name":"List products","isWebhook":false,"pointer":"/paths/~1v3~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all configured products."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/products","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/products","href":"products/listproducts","openApiOperationId":"listProducts","summary":"List products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1v3~1products/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_32","exampleIds":["paths/~1v3~1products/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1products/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_32","exampleIds":["paths/~1v3~1products/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1v3~1products/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/listproducts"}],"panels":[]}]},"httpPath":"/v3/products"},{"label":"Save a product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/products/saveproduct","routeSlug":"/zephr-api-reference/zephr-admin-api/products/saveproduct","metadata":{"seo":{"title":"Save a product","description":"This endpoint saves a product with the given details specified in the body of the request. The product ID is randomyly generated and provided as part of the URI path parameter response returned on success."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"saveProduct","name":"Save a product","isWebhook":false,"pointer":"/paths/~1v3~1products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Save a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint saves a product with the given details specified in the body of the request. The product ID is randomyly generated and provided as part of the URI path parameter response returned on success."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/product-request"}},"schemaId":"components/schemas/product-request","pointer":"/paths/~1v3~1products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/products","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/product-request"}},"responseCodes":["201","400","401","409"],"pointer":"/v3/products","href":"products/saveproduct","openApiOperationId":"saveProduct","summary":"Save a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"components/schemas/product-request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/product-request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created. The product was created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33","headers":{}},{"code":"400","description":"Bad Request. Returned if the request body is invalid.","headers":{}},{"code":"401","description":"Unauthorized. Returned if no valid authentication was provided.","headers":{}},{"code":"409","description":"Conflict. Returned when missing a reference to the entitlement.","headers":{}}],"pointer":"/paths/~1v3~1products/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400"},{"code":"401"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/saveproduct"}],"panels":[]}]},"httpPath":"/v3/products"},{"label":"Retrieve a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/products/getproduct","routeSlug":"/zephr-api-reference/zephr-admin-api/products/getproduct","metadata":{"seo":{"title":"Retrieve a product","description":"Retrieves a single product. The product is identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProduct","name":"Retrieve a product","isWebhook":false,"pointer":"/paths/~1v3~1products~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a single product. The product is identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Product identifier.","required":true}],"pointer":"/paths/~1v3~1products~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/products/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/products/{id}","href":"products/getproduct","openApiOperationId":"getProduct","summary":"Retrieve a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. Returns the product details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/product"}},"schemaId":"components/schemas/product","headers":{}},{"code":"401","description":"Unauthorized. Returned if no valid authentication was provided.","headers":{}},{"code":"404","description":"Not Found. The product does not exist.","headers":{}}],"pointer":"/paths/~1v3~1products~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/product","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/product"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getproduct"}],"panels":[]}]},"httpPath":"/v3/products/{id}"},{"label":"Delete a product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/products/deleteproduct","routeSlug":"/zephr-api-reference/zephr-admin-api/products/deleteproduct","metadata":{"seo":{"title":"Delete a product","description":"Deletes a product. The product is identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProduct","name":"Delete a product","isWebhook":false,"pointer":"/paths/~1v3~1products~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a product. The product is identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Product identifier.","required":true}],"pointer":"/paths/~1v3~1products~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/products/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v3/products/{id}","href":"products/deleteproduct","openApiOperationId":"deleteProduct","summary":"Delete a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The product was deleted.","headers":{}},{"code":"401","description":"Unauthorized. Returned if no valid authentication was provided.","headers":{}},{"code":"404","description":"Not Found. The product does not exist.","headers":{}}],"pointer":"/paths/~1v3~1products~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/deleteproduct"}],"panels":[]}]},"httpPath":"/v3/products/{id}"},{"label":"Save a product with the given ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/products/saveproducts","routeSlug":"/zephr-api-reference/zephr-admin-api/products/saveproducts","metadata":{"seo":{"title":"Save a product with the given ID","description":"This endpoint both saves and updates a product. The product is identified by the id path parameter. If the product ID does not exist, then a new product with the corresponding ID will be created. Otherwise, the existing product will be modified."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"saveProducts","name":"Save a product with the given ID","isWebhook":false,"pointer":"/paths/~1v3~1products~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Save a product with the given ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint both saves and updates a product. The product is identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter. If the product ID does not exist, then a new product with the corresponding ID will be created. Otherwise, the existing product will be modified."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Product identifier.","required":true}],"pointer":"/paths/~1v3~1products~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/product-request"}},"schemaId":"components/schemas/product-request","pointer":"/paths/~1v3~1products~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/products/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/product-request"}},"responseCodes":["200","201","400","401","409"],"pointer":"/v3/products/{id}","href":"products/saveproducts","openApiOperationId":"saveProducts","summary":"Save a product with the given ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"components/schemas/product-request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/product-request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The product was updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34","headers":{}},{"code":"201","description":"Created. The product was created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35","headers":{}},{"code":"400","description":"Bad Request. Returned if the request body is invalid.","headers":{}},{"code":"401","description":"Unauthorized. Returned if no valid authentication was provided.","headers":{}},{"code":"409","description":"Conflict. Returned when missing a reference to the entitlement.","headers":{}}],"pointer":"/paths/~1v3~1products~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"201","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}},{"code":"400"},{"code":"401"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/saveproducts"}],"panels":[]}]},"httpPath":"/v3/products/{id}"}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Product."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/products","summary":"List products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/listproducts","deprecated":false},{"title":"/v3/products","summary":"Save a product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products/saveproduct","deprecated":false},{"title":"/v3/products/{id}","summary":"Retrieve a product","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/getproduct","deprecated":false},{"title":"/v3/products/{id}","summary":"Delete a product","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/deleteproduct","deprecated":false},{"title":"/v3/products/{id}","summary":"Save a product with the given ID","prefix":{"name":"put","color":"put"},"badges":[],"link":"/products/saveproducts","deprecated":false}]}]}]}]}},{"type":"group","label":"Request Rules","link":"/zephr-api-reference/zephr-admin-api/request-rules","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules","items":[{"label":"List request rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/request-rules/listrequestrules","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules/listrequestrules","metadata":{"seo":{"title":"List request rules","description":"Retrieves a list of request rules wrapped in the element \"results\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRequestRules","name":"List request rules","isWebhook":false,"pointer":"/paths/~1v3~1request-rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List request rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of request rules wrapped in the element \"results\"."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tags","in":"query","schemaId":"schema_21","description":"A comma-separeted list of request rule tags (Maximum 50 tags allowed)"}],"pointer":"/paths/~1v3~1request-rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/request-rules","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[{"name":"tags","in":"query","example":"tag1,tag2,tag3","schemaId":"schema_21"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/request-rules","href":"request-rules/listrequestrules","openApiOperationId":"listRequestRules","summary":"List request rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Request rules have been retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/request_rules_container_object","exampleIds":["paths/~1v3~1request-rules/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/request_rules_container_object","exampleIds":["paths/~1v3~1request-rules/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request - Tags size exceeded the limit of 50","headers":{}}],"pointer":"/paths/~1v3~1request-rules/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/request_rules_container_object","exampleIds":["paths/~1v3~1request-rules/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/request_rules_container_object","exampleIds":["paths/~1v3~1request-rules/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-rules/listrequestrules"}],"panels":[]}]},"httpPath":"/v3/request-rules"},{"label":"Save a request rule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/request-rules/saverequestrule","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules/saverequestrule","metadata":{"seo":{"title":"Save a request rule","description":"Saves a request rule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"saveRequestRule","name":"Save a request rule","isWebhook":false,"pointer":"/paths/~1v3~1request-rules/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Save a request rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Saves a request rule."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36","pointer":"/paths/~1v3~1request-rules/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/request-rules","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_36"}},"responseCodes":["200","201","400"],"pointer":"/v3/request-rules","href":"request-rules/saverequestrule","openApiOperationId":"saveRequestRule","summary":"Save a request rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_36"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1request-rules/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-rules/saverequestrule"}],"panels":[]}]},"httpPath":"/v3/request-rules"},{"label":"Delete a request rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/request-rules/deleterequestrule","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules/deleterequestrule","metadata":{"seo":{"title":"Delete a request rule","description":"Deletes a request rule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRequestRule","name":"Delete a request rule","isWebhook":false,"pointer":"/paths/~1v3~1request-rules~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a request rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a request rule."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Request Rule identifier","required":true}],"pointer":"/paths/~1v3~1request-rules~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/request-rules/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/request-rules/{id}","href":"request-rules/deleterequestrule","openApiOperationId":"deleteRequestRule","summary":"Delete a request rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1request-rules~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-rules/deleterequestrule"}],"panels":[]}]},"httpPath":"/v3/request-rules/{id}"},{"label":"Retrieve a particular version of a request rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/request-rules/getrequestruleversion","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules/getrequestruleversion","metadata":{"seo":{"title":"Retrieve a particular version of a request rule","description":"Retrieves a request rule version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRequestRuleVersion","name":"Retrieve a particular version of a request rule","isWebhook":false,"pointer":"/paths/~1v3~1request-rules~1{id}~1versions~1{versionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a particular version of a request rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a request rule version."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Request Rule identifier","required":true},{"name":"versionId","in":"path","schemaId":"schema_37","description":"Unique Request Rule version number","required":true}],"pointer":"/paths/~1v3~1request-rules~1{id}~1versions~1{versionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/request-rules/{id}/versions/{versionId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"versionId","in":"path","required":true,"schemaId":"schema_37"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/request-rules/{id}/versions/{versionId}","href":"request-rules/getrequestruleversion","openApiOperationId":"getRequestRuleVersion","summary":"Retrieve a particular version of a request rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/request_rules_object"}},"schemaId":"components/schemas/request_rules_object","headers":{}}],"pointer":"/paths/~1v3~1request-rules~1{id}~1versions~1{versionId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/request_rules_object","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/request_rules_object"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-rules/getrequestruleversion"}],"panels":[]}]},"httpPath":"/v3/request-rules/{id}/versions/{versionId}"},{"label":"Delete a request rule version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/request-rules/deleterequestruleversion","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules/deleterequestruleversion","metadata":{"seo":{"title":"Delete a request rule version","description":"Deletes a request rule version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRequestRuleVersion","name":"Delete a request rule version","isWebhook":false,"pointer":"/paths/~1v3~1request-rules~1{id}~1versions~1{versionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a request rule version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a request rule version."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Request Rule identifier","required":true},{"name":"versionId","in":"path","schemaId":"schema_0","description":"Unique Request Rule version identifier","required":true}],"pointer":"/paths/~1v3~1request-rules~1{id}~1versions~1{versionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/request-rules/{id}/versions/{versionId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"versionId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/request-rules/{id}/versions/{versionId}","href":"request-rules/deleterequestruleversion","openApiOperationId":"deleteRequestRuleVersion","summary":"Delete a request rule version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1request-rules~1{id}~1versions~1{versionId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-rules/deleterequestruleversion"}],"panels":[]}]},"httpPath":"/v3/request-rules/{id}/versions/{versionId}"}],"content":{"contentType":"group","meta":{"name":"Request Rules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request Rules","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Request Rules."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/request-rules","summary":"List request rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/request-rules/listrequestrules","deprecated":false},{"title":"/v3/request-rules","summary":"Save a request rule","prefix":{"name":"put","color":"put"},"badges":[],"link":"/request-rules/saverequestrule","deprecated":false},{"title":"/v3/request-rules/{id}","summary":"Delete a request rule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/request-rules/deleterequestrule","deprecated":false},{"title":"/v3/request-rules/{id}/versions/{versionId}","summary":"Retrieve a particular version of a request rule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/request-rules/getrequestruleversion","deprecated":false},{"title":"/v3/request-rules/{id}/versions/{versionId}","summary":"Delete a request rule version","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/request-rules/deleterequestruleversion","deprecated":false}]}]}]}]}},{"type":"group","label":"Session","link":"/zephr-api-reference/zephr-admin-api/session","routeSlug":"/zephr-api-reference/zephr-admin-api/session","items":[{"label":"Create a session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/session/createnewsession","routeSlug":"/zephr-api-reference/zephr-admin-api/session/createnewsession","metadata":{"seo":{"title":"Create a session","description":"Creates a new session."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNewSession","name":"Create a session","isWebhook":false,"pointer":"/paths/~1v3~1sessions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new session."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_3"}},"schemaId":"schema_3","pointer":"/paths/~1v3~1sessions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/sessions","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_3"}},"responseCodes":["200","400"],"pointer":"/v3/sessions","href":"session/createnewsession","openApiOperationId":"createNewSession","summary":"Create a session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_3","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_3"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/session","exampleIds":["paths/~1v3~1sessions/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/session","exampleIds":["paths/~1v3~1sessions/post/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1sessions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/session","exampleIds":["paths/~1v3~1sessions/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/session","exampleIds":["paths/~1v3~1sessions/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/session/createnewsession"}],"panels":[]}]},"httpPath":"/v3/sessions"},{"label":"Retrieve a session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/session/getsession","routeSlug":"/zephr-api-reference/zephr-admin-api/session/getsession","metadata":{"seo":{"title":"Retrieve a session","description":"Looks up a session."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSession","name":"Retrieve a session","isWebhook":false,"pointer":"/paths/~1v3~1sessions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Looks up a session."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Session identifier","required":true}],"pointer":"/paths/~1v3~1sessions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/sessions/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/sessions/{id}","href":"session/getsession","openApiOperationId":"getSession","summary":"Retrieve a session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/session-lookup","exampleIds":["paths/~1v3~1sessions~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/session-lookup","exampleIds":["paths/~1v3~1sessions~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1sessions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/session-lookup","exampleIds":["paths/~1v3~1sessions~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/session-lookup","exampleIds":["paths/~1v3~1sessions~1{id}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/session/getsession"}],"panels":[]}]},"httpPath":"/v3/sessions/{id}"}],"content":{"contentType":"group","meta":{"name":"Session"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Session","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Session."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/sessions","summary":"Create a session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/session/createnewsession","deprecated":false},{"title":"/v3/sessions/{id}","summary":"Retrieve a session","prefix":{"name":"get","color":"get"},"badges":[],"link":"/session/getsession","deprecated":false}]}]}]}]}},{"type":"group","label":"Static Items","link":"/zephr-api-reference/zephr-admin-api/static-items","routeSlug":"/zephr-api-reference/zephr-admin-api/static-items","items":[{"label":"List static items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/static-items/liststaticitems","routeSlug":"/zephr-api-reference/zephr-admin-api/static-items/liststaticitems","metadata":{"seo":{"title":"List static items","description":"Retrieves a list of static item ids wrapped in the element \"results\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listStaticItems","name":"List static items","isWebhook":false,"pointer":"/paths/~1v3~1static/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List static items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of static item ids wrapped in the element \"results\"."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/static","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/static","href":"static-items/liststaticitems","openApiOperationId":"listStaticItems","summary":"List static items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/static_items","exampleIds":["paths/~1v3~1static/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/static_items","exampleIds":["paths/~1v3~1static/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1static/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/static_items","exampleIds":["paths/~1v3~1static/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/static_items","exampleIds":["paths/~1v3~1static/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/static-items/liststaticitems"}],"panels":[]}]},"httpPath":"/v3/static"},{"label":"Retrieve a static item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/static-items/getitem","routeSlug":"/zephr-api-reference/zephr-admin-api/static-items/getitem","metadata":{"seo":{"title":"Retrieve a static item","description":"Retrieves a static item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getItem","name":"Retrieve a static item","isWebhook":false,"pointer":"/paths/~1v3~1static~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a static item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a static item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Static Item identifier","required":true}],"pointer":"/paths/~1v3~1static~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/static/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/static/{id}","href":"static-items/getitem","openApiOperationId":"getItem","summary":"Retrieve a static item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/static_single_item","exampleIds":["paths/~1v3~1static~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/static_single_item","exampleIds":["paths/~1v3~1static~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1static~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/static_single_item","exampleIds":["paths/~1v3~1static~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/static_single_item","exampleIds":["paths/~1v3~1static~1{id}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/static-items/getitem"}],"panels":[]}]},"httpPath":"/v3/static/{id}"},{"label":"Delete a static item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/static-items/delete_item","routeSlug":"/zephr-api-reference/zephr-admin-api/static-items/delete_item","metadata":{"seo":{"title":"Delete a static item","description":"Deletes a static item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete_Item","name":"Delete a static item","isWebhook":false,"pointer":"/paths/~1v3~1static~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a static item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a static item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Static Item identifier","required":true}],"pointer":"/paths/~1v3~1static~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/static/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/static/{id}","href":"static-items/delete_item","openApiOperationId":"Delete_Item","summary":"Delete a static item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1static~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/static-items/delete_item"}],"panels":[]}]},"httpPath":"/v3/static/{id}"},{"label":"Save a static item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/static-items/saveitem","routeSlug":"/zephr-api-reference/zephr-admin-api/static-items/saveitem","metadata":{"seo":{"title":"Save a static item","description":"Saves a static item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"saveItem","name":"Save a static item","isWebhook":false,"pointer":"/paths/~1v3~1static~1{id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Save a static item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Saves a static item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Static Item identifier","required":true}],"pointer":"/paths/~1v3~1static~1{id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/static/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","201","400"],"pointer":"/v3/static/{id}","href":"static-items/saveitem","openApiOperationId":"saveItem","summary":"Save a static item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1static~1{id}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/static-items/saveitem"}],"panels":[]}]},"httpPath":"/v3/static/{id}"}],"content":{"contentType":"group","meta":{"name":"Static Items"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Static Items","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Static Item."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/static","summary":"List static items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/static-items/liststaticitems","deprecated":false},{"title":"/v3/static/{id}","summary":"Retrieve a static item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/static-items/getitem","deprecated":false},{"title":"/v3/static/{id}","summary":"Delete a static item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/static-items/delete_item","deprecated":false},{"title":"/v3/static/{id}","summary":"Save a static item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/static-items/saveitem","deprecated":false}]}]}]}]}},{"type":"group","label":"Third Party Authentication","link":"/zephr-api-reference/zephr-admin-api/third-party-authentication","routeSlug":"/zephr-api-reference/zephr-admin-api/third-party-authentication","items":[{"label":"Token refresh or exchange","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/third-party-authentication/refreshorexchangetoken","routeSlug":"/zephr-api-reference/zephr-admin-api/third-party-authentication/refreshorexchangetoken","metadata":{"seo":{"title":"Token refresh or exchange","description":"Exchanges the OAuth2 authorization code for an access token, or refreshes an existing access token using a refresh token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"refreshOrExchangeToken","name":"Token refresh or exchange","isWebhook":false,"pointer":"/paths/~1zephr~1oauth2~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Token refresh or exchange","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Exchanges the OAuth2 authorization code for an access token, or refreshes an existing access token using a refresh token."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1zephr~1oauth2~1token/post/requestBody/content/application~1json/examples/RefreshToken","paths/~1zephr~1oauth2~1token/post/requestBody/content/application~1json/examples/AuthorizationCode"]}},"schemaId":"schema_38","exampleIds":["paths/~1zephr~1oauth2~1token/post/requestBody/content/application~1json/examples/RefreshToken","paths/~1zephr~1oauth2~1token/post/requestBody/content/application~1json/examples/AuthorizationCode"],"pointer":"/paths/~1zephr~1oauth2~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/zephr/oauth2/token","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1zephr~1oauth2~1token/post/requestBody/content/application~1json/examples/RefreshToken","paths/~1zephr~1oauth2~1token/post/requestBody/content/application~1json/examples/AuthorizationCode"]}},"responseCodes":["200"],"pointer":"/zephr/oauth2/token","href":"third-party-authentication/refreshorexchangetoken","openApiOperationId":"refreshOrExchangeToken","summary":"Token refresh or exchange"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_38","exampleIds":["paths/~1zephr~1oauth2~1token/post/requestBody/content/application~1json/examples/RefreshToken","paths/~1zephr~1oauth2~1token/post/requestBody/content/application~1json/examples/AuthorizationCode"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1zephr~1oauth2~1token/post/requestBody/content/application~1json/examples/RefreshToken","paths/~1zephr~1oauth2~1token/post/requestBody/content/application~1json/examples/AuthorizationCode"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39"}],"pointer":"/paths/~1zephr~1oauth2~1token/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/third-party-authentication/refreshorexchangetoken"}],"panels":[]}]},"httpPath":"/zephr/oauth2/token"}],"content":{"contentType":"group","meta":{"name":"Third Party Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Third Party Authentication","showPageActions":true},{"nodeType":"markdoc","content":"Contains operations for the OAuth 2.0 Authorization Code Flow Token Exchange."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/zephr/oauth2/token","summary":"Token refresh or exchange","prefix":{"name":"post","color":"post"},"badges":[],"link":"/third-party-authentication/refreshorexchangetoken","deprecated":false}]}]}]}]}},{"type":"group","label":"User Export","link":"/zephr-api-reference/zephr-admin-api/user-export","routeSlug":"/zephr-api-reference/zephr-admin-api/user-export","items":[{"label":"Export users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/user-export/exportusers","routeSlug":"/zephr-api-reference/zephr-admin-api/user-export/exportusers","metadata":{"seo":{"title":"Export users","description":"Export users who match the provided parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportUsers","name":"Export users","isWebhook":false,"pointer":"/paths/~1v3~1user-export/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Export users who match the provided parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"attributes","in":"query","schemaId":"schema_27","description":"Whether or not to include core attributes.","required":true,"example":"true"},{"name":"appIds","in":"query","schemaId":"schema_0","description":"Comma-delimited list of appIds to retrieve extended profile data for. If appIds is present and attributes isn't, only users with matching extended profiles will be returned.","required":true,"example":"quiz1,survey4"},{"name":"appIdsRestrictive","in":"query","schemaId":"schema_27","description":"Only include users with a matching extended profile","example":"true"},{"name":"grants","in":"query","schemaId":"schema_27","description":"Include information about entitlements","example":"true"},{"name":"since","in":"query","schemaId":"schema_0","description":"Users who were updated after the specified date","example":"2020-01-01T00:00:00Z"},{"name":"registeredSince","in":"query","schemaId":"schema_0","description":"Users who have registered after the specified date","example":"2020-01-01T00:00:00Z"},{"name":"registeredBefore","in":"query","schemaId":"schema_0","description":"Users who have registered before the specified date","example":"2020-01-01T00:00:00Z"},{"name":"rpp","in":"query","schemaId":"schema_40","description":"Results per page","example":40},{"name":"page","in":"query","schemaId":"schema_41","description":"The requested page of results","example":1}],"pointer":"/paths/~1v3~1user-export/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/user-export","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[{"name":"attributes","in":"query","required":true,"example":"true","schemaId":"schema_27"},{"name":"appIds","in":"query","required":true,"example":"quiz1,survey4","schemaId":"schema_0"},{"name":"appIdsRestrictive","in":"query","required":false,"example":"true","schemaId":"schema_27"},{"name":"grants","in":"query","required":false,"example":"true","schemaId":"schema_27"},{"name":"since","in":"query","required":false,"example":"2020-01-01T00:00:00Z","schemaId":"schema_0"},{"name":"registeredSince","in":"query","required":false,"example":"2020-01-01T00:00:00Z","schemaId":"schema_0"},{"name":"registeredBefore","in":"query","required":false,"example":"2020-01-01T00:00:00Z","schemaId":"schema_0"},{"name":"rpp","in":"query","required":false,"example":40,"schemaId":"schema_40"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_41"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/user-export","href":"user-export/exportusers","openApiOperationId":"exportUsers","summary":"Export users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - The paginated user data has been exported successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user-export-paginated-response"}},"schemaId":"components/schemas/user-export-paginated-response","headers":{}}],"pointer":"/paths/~1v3~1user-export/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/user-export-paginated-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user-export-paginated-response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-export/exportusers"}],"panels":[]}]},"httpPath":"/v3/user-export"},{"label":"Export users and user events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/user-export/exportuserandeventscsv","routeSlug":"/zephr-api-reference/zephr-admin-api/user-export/exportuserandeventscsv","metadata":{"seo":{"title":"Export users and user events","description":"Downloads all subscribers and subscriber events data in csv format."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportUserAndEventsCSV","name":"Export users and user events","isWebhook":false,"pointer":"/paths/~1v4~1user-export/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export users and user events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Downloads all subscribers and subscriber events data in csv format."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To download subscribers data, specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appIdsRestrictive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grants"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"since"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registeredSince"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registeredBefore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foreignKeys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To download subscriber events data, specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventsExport"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For pagination, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rpp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"attributes","in":"query","schemaId":"schema_27","description":"Whether or not to include core attributes","example":"true"},{"name":"attr","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-delimited list of user attribute filters in the following format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attributeKey.operation.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attributeKey.operation.value1.value2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"attr1.contains.a,attr2.equals.3"},{"name":"appIds","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-delimited list of appIds to retrieve extended profile data for. If appIds is present and attributes isn't, only users with matching extended profiles will be returned. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve all extended profile data."},"children":[]}]}]}],"example":"quiz1,survey4,all"},{"name":"appIdsRestrictive","in":"query","schemaId":"schema_27","description":"Only include users with a matching extended profile","example":"true"},{"name":"grants","in":"query","schemaId":"schema_27","description":"Include information about entitlements","example":"true"},{"name":"since","in":"query","schemaId":"schema_0","description":"Users who were updated after the specified date","example":"2020-01-01T00:00:00Z"},{"name":"registeredSince","in":"query","schemaId":"schema_0","description":"Users who have registered after the specified date","example":"2020-01-01T00:00:00Z"},{"name":"registeredBefore","in":"query","schemaId":"schema_0","description":"Users who have registered before the specified date","example":"2020-01-01T00:00:00Z"},{"name":"foreignKeys","in":"query","schemaId":"schema_27","description":"Include user foreign keys","example":"true"},{"name":"eventsExport","in":"query","schemaId":"schema_0","description":"Indicates to export the subscriber events csv file","example":""},{"name":"from","in":"query","schemaId":"schema_0","description":"Subscriber event after the specified date","example":"2020-01-01T00:00:00Z"},{"name":"to","in":"query","schemaId":"schema_0","description":"Subscriber event before the specified date","example":"2020-01-02T00:00:00Z"},{"name":"rpp","in":"query","schemaId":"schema_40","description":"Results per page","example":40},{"name":"page","in":"query","schemaId":"schema_41","description":"The requested page of results","example":1}],"pointer":"/paths/~1v4~1user-export/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/user-export","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[{"name":"attributes","in":"query","required":false,"example":"true","schemaId":"schema_27"},{"name":"attr","in":"query","required":false,"example":"attr1.contains.a,attr2.equals.3","schemaId":"schema_0"},{"name":"appIds","in":"query","required":false,"example":"quiz1,survey4,all","schemaId":"schema_0"},{"name":"appIdsRestrictive","in":"query","required":false,"example":"true","schemaId":"schema_27"},{"name":"grants","in":"query","required":false,"example":"true","schemaId":"schema_27"},{"name":"since","in":"query","required":false,"example":"2020-01-01T00:00:00Z","schemaId":"schema_0"},{"name":"registeredSince","in":"query","required":false,"example":"2020-01-01T00:00:00Z","schemaId":"schema_0"},{"name":"registeredBefore","in":"query","required":false,"example":"2020-01-01T00:00:00Z","schemaId":"schema_0"},{"name":"foreignKeys","in":"query","required":false,"example":"true","schemaId":"schema_27"},{"name":"eventsExport","in":"query","required":false,"example":"","schemaId":"schema_0"},{"name":"from","in":"query","required":false,"example":"2020-01-01T00:00:00Z","schemaId":"schema_0"},{"name":"to","in":"query","required":false,"example":"2020-01-02T00:00:00Z","schemaId":"schema_0"},{"name":"rpp","in":"query","required":false,"example":40,"schemaId":"schema_40"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_41"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/user-export","href":"user-export/exportuserandeventscsv","openApiOperationId":"exportUserAndEventsCSV","summary":"Export users and user events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - User and user event data have been returned successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user-export-paginated-response"}},"schemaId":"components/schemas/user-export-paginated-response","headers":{}}],"pointer":"/paths/~1v4~1user-export/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/user-export-paginated-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user-export-paginated-response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-export/exportuserandeventscsv"}],"panels":[]}]},"httpPath":"/v4/user-export"}],"content":{"contentType":"group","meta":{"name":"User Export"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Export","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/user-export","summary":"Export users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-export/exportusers","deprecated":false},{"title":"/v4/user-export","summary":"Export users and user events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-export/exportuserandeventscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"User Schema","link":"/zephr-api-reference/zephr-admin-api/user-schema","routeSlug":"/zephr-api-reference/zephr-admin-api/user-schema","items":[{"label":"Retrieve a user schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/user-schema/retrieveuserschema","routeSlug":"/zephr-api-reference/zephr-admin-api/user-schema/retrieveuserschema","metadata":{"seo":{"title":"Retrieve a user schema","description":"Retrieves a user Schema."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveUserSchema","name":"Retrieve a user schema","isWebhook":false,"pointer":"/paths/~1v3~1schema~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a user schema","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a user Schema."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/schema/users","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/schema/users","href":"user-schema/retrieveuserschema","openApiOperationId":"retrieveUserSchema","summary":"Retrieve a user schema"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/schemas","exampleIds":["paths/~1v3~1schema~1users/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/schemas","exampleIds":["paths/~1v3~1schema~1users/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1schema~1users/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/schemas","exampleIds":["paths/~1v3~1schema~1users/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/schemas","exampleIds":["paths/~1v3~1schema~1users/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-schema/retrieveuserschema"}],"panels":[]}]},"httpPath":"/v3/schema/users"},{"label":"Retrieve a schema slug","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/user-schema/getschemaslug","routeSlug":"/zephr-api-reference/zephr-admin-api/user-schema/getschemaslug","metadata":{"seo":{"title":"Retrieve a schema slug","description":"Retrieves a schema slug."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSchemaSlug","name":"Retrieve a schema slug","isWebhook":false,"pointer":"/paths/~1v3~1schema~1users~1{slug}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a schema slug","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a schema slug."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"slug","in":"path","schemaId":"schema_0","description":"Unique identifier","required":true}],"pointer":"/paths/~1v3~1schema~1users~1{slug}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/schema/users/{slug}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"slug","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/schema/users/{slug}","href":"user-schema/getschemaslug","openApiOperationId":"getSchemaSlug","summary":"Retrieve a schema slug"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/schema-field"}},"schemaId":"components/schemas/schema-field","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1schema~1users~1{slug}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/schema-field","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/schema-field"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-schema/getschemaslug"}],"panels":[]}]},"httpPath":"/v3/schema/users/{slug}"},{"label":"Delete a schema slug","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/user-schema/deleteschemaslug","routeSlug":"/zephr-api-reference/zephr-admin-api/user-schema/deleteschemaslug","metadata":{"seo":{"title":"Delete a schema slug","description":"Deletes a schema slug."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSchemaSlug","name":"Delete a schema slug","isWebhook":false,"pointer":"/paths/~1v3~1schema~1users~1{slug}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a schema slug","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a schema slug."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"slug","in":"path","schemaId":"schema_0","description":"Unique identifier","required":true}],"pointer":"/paths/~1v3~1schema~1users~1{slug}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/schema/users/{slug}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"slug","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/schema/users/{slug}","href":"user-schema/deleteschemaslug","openApiOperationId":"deleteSchemaSlug","summary":"Delete a schema slug"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/schema-field-deletion-response"}},"schemaId":"components/schemas/schema-field-deletion-response","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1schema~1users~1{slug}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/schema-field-deletion-response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/schema-field-deletion-response"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-schema/deleteschemaslug"}],"panels":[]}]},"httpPath":"/v3/schema/users/{slug}"},{"label":"Save a schema slug","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/user-schema/saveschemaslug","routeSlug":"/zephr-api-reference/zephr-admin-api/user-schema/saveschemaslug","metadata":{"seo":{"title":"Save a schema slug","description":"Saves a schema slug."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"saveSchemaSlug","name":"Save a schema slug","isWebhook":false,"pointer":"/paths/~1v3~1schema~1users~1{slug}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Save a schema slug","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Saves a schema slug."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"slug","in":"path","schemaId":"schema_0","description":"Unique identifier","required":true}],"pointer":"/paths/~1v3~1schema~1users~1{slug}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/schema-field"}},"schemaId":"components/schemas/schema-field","pointer":"/paths/~1v3~1schema~1users~1{slug}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/schema/users/{slug}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"slug","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/schema-field"}},"responseCodes":["200","201","400"],"pointer":"/v3/schema/users/{slug}","href":"user-schema/saveschemaslug","openApiOperationId":"saveSchemaSlug","summary":"Save a schema slug"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"components/schemas/schema-field","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/schema-field"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated","headers":{}},{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/schema-field-creation-response","exampleIds":["paths/~1v3~1schema~1users~1{slug}/put/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/schema-field-creation-response","exampleIds":["paths/~1v3~1schema~1users~1{slug}/put/responses/201/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1schema~1users~1{slug}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"201","schemaId":"components/schemas/schema-field-creation-response","exampleIds":["paths/~1v3~1schema~1users~1{slug}/put/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/schema-field-creation-response","exampleIds":["paths/~1v3~1schema~1users~1{slug}/put/responses/201/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-schema/saveschemaslug"}],"panels":[]}]},"httpPath":"/v3/schema/users/{slug}"}],"content":{"contentType":"group","meta":{"name":"User Schema"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Schema","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource User Schema."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/schema/users","summary":"Retrieve a user schema","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-schema/retrieveuserschema","deprecated":false},{"title":"/v3/schema/users/{slug}","summary":"Retrieve a schema slug","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-schema/getschemaslug","deprecated":false},{"title":"/v3/schema/users/{slug}","summary":"Delete a schema slug","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user-schema/deleteschemaslug","deprecated":false},{"title":"/v3/schema/users/{slug}","summary":"Save a schema slug","prefix":{"name":"put","color":"put"},"badges":[],"link":"/user-schema/saveschemaslug","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/zephr-api-reference/zephr-admin-api/users","routeSlug":"/zephr-api-reference/zephr-admin-api/users","items":[{"label":"Delete an end user by primary ID or foreign key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/deleteuserbyprimaryorforeignkey","routeSlug":"/zephr-api-reference/zephr-admin-api/users/deleteuserbyprimaryorforeignkey","metadata":{"seo":{"title":"Delete an end user by primary ID or foreign key","description":"Deletes an end user and associated data from the system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUserByPrimaryOrForeignKey","name":"Delete an end user by primary ID or foreign key","isWebhook":false,"pointer":"/paths/~1zephr~1integration~1users~1v1~1users/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an end user by primary ID or foreign key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an end user and associated data from the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint applies to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"end users (C2 users)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not admin users."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must provide "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly one"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the following identifier options:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option A — Delete by primary ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary_id"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option B — Delete by foreign key"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foreign[system]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foreign[key]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"either"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foreign[system]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foreign[key]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provide both identifier options in the same request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If parameters are missing, incomplete, or conflicting, the API returns "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete JWT users who do not have a foreign system mapping (for example, users whose data exists in DynamoDB but not in the SQL database), provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zephr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foreign[system]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete by primary ID:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /zephr/integration/users/v1/users?primary_id=123456"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete by foreign key:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /zephr/integration/users/v1/users?foreign[system]=my-system&foreign[key]=alexuser-12345"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete JWT user with no foreign mapping (DynamoDB-only):"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /zephr/integration/users/v1/users?foreign[system]=zephr&foreign[key]=alexuser-12345"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"primary_id","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Zephr internal primary user ID of the user to be deleted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide this parameter "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when deleting by primary ID (Option A)."},"children":[]}]}]}]},{"name":"foreign[system]","in":"query","schemaId":"schema_0","description":"The configured foreign key system defined in the JWT settings.\nRequired when deleting by foreign key (Option B).\n","example":"zephr"},{"name":"foreign[key]","in":"query","schemaId":"schema_0","description":"The external persistent user identifier linked to the user (from the JWT).\nRequired when deleting by foreign key (Option B).\n","example":"user_998877"}],"pointer":"/paths/~1zephr~1integration~1users~1v1~1users/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/zephr/integration/users/v1/users","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[{"name":"primary_id","in":"query","required":false,"example":"123456","schemaId":"schema_42"},{"name":"foreign[system]","in":"query","required":false,"example":"zephr","schemaId":"schema_0"},{"name":"foreign[key]","in":"query","required":false,"example":"user_998877","schemaId":"schema_0"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["204","400","404"],"pointer":"/zephr/integration/users/v1/users","href":"users/deleteuserbyprimaryorforeignkey","openApiOperationId":"deleteUserByPrimaryOrForeignKey","summary":"Delete an end user by primary ID or foreign key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted successfully (no content)."},{"code":"400","description":"Bad request (missing, incomplete, or conflicting query parameters)."},{"code":"404","description":"User not found."}],"pointer":"/paths/~1zephr~1integration~1users~1v1~1users/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/deleteuserbyprimaryorforeignkey"}],"panels":[]}]},"httpPath":"/zephr/integration/users/v1/users"},{"label":"Insert a foreign key","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/upsertforeignkey","routeSlug":"/zephr-api-reference/zephr-admin-api/users/upsertforeignkey","metadata":{"seo":{"title":"Insert a foreign key","description":"Adds a foreign key mapping to a user. This operation does not update or overwrite an existing mapping. A user can have multiple foreign keys for the same system. To replace an existing mapping, first delete the current mapping using the Delete a foreign key operation, then call this operation with the new foreign key value."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertForeignKey","name":"Insert a foreign key","isWebhook":false,"pointer":"/paths/~1v3~1users~1{userId}~1foreign-key~1update~1{key}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert a foreign key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a foreign key mapping to a user. This operation does not update or overwrite an existing mapping. A user can have multiple foreign keys for the same system. To replace an existing mapping, first delete the current mapping using the Delete a foreign key operation, then call this operation with the new foreign key value."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true,"example":"3f589a2d-86cd-4b70-a5df-68dca75a3a21"},{"name":"key","in":"path","schemaId":"schema_0","description":"Foreign system key","required":true,"example":"foreign_system_key"}],"pointer":"/paths/~1v3~1users~1{userId}~1foreign-key~1update~1{key}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_0","exampleIds":["paths/~1v3~1users~1{userId}~1foreign-key~1update~1{key}/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_0","exampleIds":["paths/~1v3~1users~1{userId}~1foreign-key~1update~1{key}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1v3~1users~1{userId}~1foreign-key~1update~1{key}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/users/{userId}/foreign-key/update/{key}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":"3f589a2d-86cd-4b70-a5df-68dca75a3a21","schemaId":"schema_0"},{"name":"key","in":"path","required":true,"example":"foreign_system_key","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_0","exampleIds":["paths/~1v3~1users~1{userId}~1foreign-key~1update~1{key}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","404"],"pointer":"/v3/users/{userId}/foreign-key/update/{key}","href":"users/upsertforeignkey","openApiOperationId":"upsertForeignKey","summary":"Insert a foreign key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_0","exampleIds":["paths/~1v3~1users~1{userId}~1foreign-key~1update~1{key}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_0","exampleIds":["paths/~1v3~1users~1{userId}~1foreign-key~1update~1{key}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Foreign key was successfully inserted or updated","headers":{}},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found - Cannot find a user with the supplied "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userId"},"children":[]}]}]}],"headers":{}}],"pointer":"/paths/~1v3~1users~1{userId}~1foreign-key~1update~1{key}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/upsertforeignkey"}],"panels":[]}]},"httpPath":"/v3/users/{userId}/foreign-key/update/{key}"},{"label":"Delete a foreign key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/deleteforeignkey","routeSlug":"/zephr-api-reference/zephr-admin-api/users/deleteforeignkey","metadata":{"seo":{"title":"Delete a foreign key","description":"Deletes the provided foreign key, if the supplied userId, system, and key match."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteForeignKey","name":"Delete a foreign key","isWebhook":false,"pointer":"/paths/~1v4~1users~1{userId}~1foreign-key~1{key}~1{system}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a foreign key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the provided foreign key, if the supplied "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"system"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true,"example":"3f589a2d-86cd-4b70-a5df-68dca75a3a21"},{"name":"system","in":"path","schemaId":"schema_0","description":"Foreign system name","required":true,"example":"salesforce"},{"name":"key","in":"path","schemaId":"schema_0","description":"Foreign system key","required":true,"example":"foreign_system_key"}],"pointer":"/paths/~1v4~1users~1{userId}~1foreign-key~1{key}~1{system}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_0","exampleIds":["paths/~1v4~1users~1{userId}~1foreign-key~1{key}~1{system}/delete/requestBody/content/application~1json/example"]}},"schemaId":"schema_0","exampleIds":["paths/~1v4~1users~1{userId}~1foreign-key~1{key}~1{system}/delete/requestBody/content/application~1json/example"],"pointer":"/paths/~1v4~1users~1{userId}~1foreign-key~1{key}~1{system}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/users/{userId}/foreign-key/{key}/{system}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":"3f589a2d-86cd-4b70-a5df-68dca75a3a21","schemaId":"schema_0"},{"name":"system","in":"path","required":true,"example":"salesforce","schemaId":"schema_0"},{"name":"key","in":"path","required":true,"example":"foreign_system_key","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_0","exampleIds":["paths/~1v4~1users~1{userId}~1foreign-key~1{key}~1{system}/delete/requestBody/content/application~1json/example"]}},"responseCodes":["200","404"],"pointer":"/v4/users/{userId}/foreign-key/{key}/{system}","href":"users/deleteforeignkey","openApiOperationId":"deleteForeignKey","summary":"Delete a foreign key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_0","exampleIds":["paths/~1v4~1users~1{userId}~1foreign-key~1{key}~1{system}/delete/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_0","exampleIds":["paths/~1v4~1users~1{userId}~1foreign-key~1{key}~1{system}/delete/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Foreign key was successfully deleted","headers":{}},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found - Cannot find a user with the supplied "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userId"},"children":[]}]}]}],"headers":{}}],"pointer":"/paths/~1v4~1users~1{userId}~1foreign-key~1{key}~1{system}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/deleteforeignkey"}],"panels":[]}]},"httpPath":"/v4/users/{userId}/foreign-key/{key}/{system}"},{"label":"List users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/listusers","routeSlug":"/zephr-api-reference/zephr-admin-api/users/listusers","metadata":{"seo":{"title":"List users","description":"Retrieves a list of users wrapped in the element \"results\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUsers","name":"List users","isWebhook":false,"pointer":"/paths/~1v3~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of users wrapped in the element \"results\"."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"identifiers.email_address","in":"query","schemaId":"schema_0","description":"Email address of the user to search for.","required":true,"example":"example@example.com"},{"name":"identifiers.username","in":"query","schemaId":"schema_0","description":"Username of the user to search for.","required":true,"example":"username"},{"name":"foreign_key.xxx","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Foreign key of the user to search for. The foreign system is parsed as the remainder of the parameter key name following 'foreign_id.'"},"children":[]}]}]}],"required":true,"example":"123abc"},{"name":"search","in":"query","schemaId":"schema_0","description":"Performs a general search for the specified value across multiple fields, including attributes.","required":true,"example":"abc"},{"name":"search_by_attributes","in":"query","schemaId":"schema_43","description":"Several attribute filters can be specified to search for users with particular attributes. It needs to be Base64 and URL encoded."}],"pointer":"/paths/~1v3~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/users","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[{"name":"identifiers.email_address","in":"query","required":true,"example":"example@example.com","schemaId":"schema_0"},{"name":"identifiers.username","in":"query","required":true,"example":"username","schemaId":"schema_0"},{"name":"foreign_key.xxx","in":"query","required":true,"example":"123abc","schemaId":"schema_0"},{"name":"search","in":"query","required":true,"example":"abc","schemaId":"schema_0"},{"name":"search_by_attributes","in":"query","schemaId":"components/schemas/search_by_attributes"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/users","href":"users/listusers","openApiOperationId":"listUsers","summary":"List users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/users-response","exampleIds":["paths/~1v3~1users/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/users-response","exampleIds":["paths/~1v3~1users/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1users/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/users-response","exampleIds":["paths/~1v3~1users/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/users-response","exampleIds":["paths/~1v3~1users/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/listusers"}],"panels":[]}]},"httpPath":"/v3/users"},{"label":"Create a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/createuser","routeSlug":"/zephr-api-reference/zephr-admin-api/users/createuser","metadata":{"seo":{"title":"Create a user","description":"Creates a new user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUser","name":"Create a user","isWebhook":false,"pointer":"/paths/~1v3~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/user-creation"}},"schemaId":"components/schemas/user-creation","pointer":"/paths/~1v3~1users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/users","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/user-creation"}},"responseCodes":["201","400"],"pointer":"/v3/users","href":"users/createuser","openApiOperationId":"createUser","summary":"Create a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"components/schemas/user-creation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/user-creation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/users-response","exampleIds":["paths/~1v3~1users/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/users-response","exampleIds":["paths/~1v3~1users/post/responses/201/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1users/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/users-response","exampleIds":["paths/~1v3~1users/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/users-response","exampleIds":["paths/~1v3~1users/post/responses/201/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/createuser"}],"panels":[]}]},"httpPath":"/v3/users"},{"label":"Retrieve a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/getuser","routeSlug":"/zephr-api-reference/zephr-admin-api/users/getuser","metadata":{"seo":{"title":"Retrieve a user","description":"Retrieves a user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUser","name":"Retrieve a user","isWebhook":false,"pointer":"/paths/~1v3~1users~1{user_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1users~1{user_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/users/{user_id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/users/{user_id}","href":"users/getuser","openApiOperationId":"getUser","summary":"Retrieve a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user-response","exampleIds":["paths/~1v3~1users~1{user_id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/user-response","exampleIds":["paths/~1v3~1users~1{user_id}/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1users~1{user_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/user-response","exampleIds":["paths/~1v3~1users~1{user_id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user-response","exampleIds":["paths/~1v3~1users~1{user_id}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getuser"}],"panels":[]}]},"httpPath":"/v3/users/{user_id}"},{"label":"Delete a user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/deleteuser","routeSlug":"/zephr-api-reference/zephr-admin-api/users/deleteuser","metadata":{"seo":{"title":"Delete a user","description":"Deletes a user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUser","name":"Delete a user","isWebhook":false,"pointer":"/paths/~1v3~1users~1{user_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1users~1{user_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/users/{user_id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/users/{user_id}","href":"users/deleteuser","openApiOperationId":"deleteUser","summary":"Delete a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1users~1{user_id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/deleteuser"}],"panels":[]}]},"httpPath":"/v3/users/{user_id}"},{"label":"Update all user attributes","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/replaceuserattributes","routeSlug":"/zephr-api-reference/zephr-admin-api/users/replaceuserattributes","metadata":{"seo":{"title":"Update all user attributes","description":"Replaces a user's attributes. This will replace any existing attributes for the user with the attributes in the payload. To leave existing attributes in place, use PATCH."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceUserAttributes","name":"Update all user attributes","isWebhook":false,"pointer":"/paths/~1v3~1users~1{user_id}~1attributes/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update all user attributes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces a user's attributes. This will replace any existing attributes for the user with the attributes in the payload.\nTo leave existing attributes in place, use PATCH."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1users~1{user_id}~1attributes/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_44"}},"schemaId":"schema_44","pointer":"/paths/~1v3~1users~1{user_id}~1attributes/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/users/{user_id}/attributes","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_44"}},"responseCodes":["200","400","404"],"pointer":"/v3/users/{user_id}/attributes","href":"users/replaceuserattributes","openApiOperationId":"replaceUserAttributes","summary":"Update all user attributes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_44","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_44"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"400","description":"Bad Request","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1users~1{user_id}~1attributes/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/replaceuserattributes"}],"panels":[]}]},"httpPath":"/v3/users/{user_id}/attributes"},{"label":"Update user attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/updateuserattribute","routeSlug":"/zephr-api-reference/zephr-admin-api/users/updateuserattribute","metadata":{"seo":{"title":"Update user attributes","description":"Updates a user's attributes. Any of the user's existing attributes not specified in the payload will be left in-place."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUserAttribute","name":"Update user attributes","isWebhook":false,"pointer":"/paths/~1v3~1users~1{user_id}~1attributes/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update user attributes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a user's attributes. Any of the user's existing attributes not specified in the payload will be left in-place."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1users~1{user_id}~1attributes/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_44"}},"schemaId":"schema_44","pointer":"/paths/~1v3~1users~1{user_id}~1attributes/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/users/{user_id}/attributes","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_44"}},"responseCodes":["200","400","404"],"pointer":"/v3/users/{user_id}/attributes","href":"users/updateuserattribute","openApiOperationId":"updateUserAttribute","summary":"Update user attributes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_44","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_44"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"400","description":"Bad Request","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1users~1{user_id}~1attributes/patch/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/updateuserattribute"}],"panels":[]}]},"httpPath":"/v3/users/{user_id}/attributes"},{"label":"Retrieve Extended User Profiles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/paths/~1v3~1users~1{user_id}~1profile~1{app_id}/get","routeSlug":"/zephr-api-reference/zephr-admin-api/users/paths/~1v3~1users~1{user_id}~1profile~1{app_id}/get","metadata":{"seo":{"title":"Retrieve Extended User Profiles","description":"Extended Profile is used to store additional user information that is not part of the core profile. This endpoint is designed to be used for retrieving the user's Extended Profile. The body can be any valid JSON."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Retrieve Extended User Profiles","isWebhook":false,"pointer":"/paths/~1v3~1users~1{user_id}~1profile~1{app_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Extended User Profiles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Extended Profile is used to store additional user information that is not part of the core profile. This endpoint is designed to be used for retrieving the user's Extended Profile. The body can be any valid JSON."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User Identifier","required":true},{"name":"app_id","in":"path","schemaId":"schema_0","description":"Unique App Identifier","required":true}],"pointer":"/paths/~1v3~1users~1{user_id}~1profile~1{app_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/users/{user_id}/profile/{app_id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"},{"name":"app_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/users/{user_id}/profile/{app_id}","href":"users/paths/~1v3~1users~1{user_id}~1profile~1{app_id}/get","summary":"Retrieve Extended User Profiles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}},"schemaId":"schema_45","headers":{}},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Thrown when app_id starts with _restricted."},"children":[]}]}]}],"headers":{}},{"code":"401","description":"Unauthorized. The user is not authorized to fetch the profile.","headers":{}},{"code":"404","description":"Not Found. The provided user does not exist.","headers":{}}],"pointer":"/paths/~1v3~1users~1{user_id}~1profile~1{app_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_45","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/paths/~1v3~1users~1{user_id}~1profile~1{app_id}/get"}],"panels":[]}]},"httpPath":"/v3/users/{user_id}/profile/{app_id}"},{"label":"Update users in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/updatebulkusers","routeSlug":"/zephr-api-reference/zephr-admin-api/users/updatebulkusers","metadata":{"seo":{"title":"Update users in bulk","description":"Updates user's attributfoes or delete users on a bulk basis."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBulkUsers","name":"Update users in bulk","isWebhook":false,"pointer":"/paths/~1v4~1user-updates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update users in bulk","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates user's attributfoes or delete users on a bulk basis. \n\nWhen setting attributes, any of the user's existing attributes not specified in the payload will be left in-place.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_46","exampleIds":["paths/~1v4~1user-updates/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_46","exampleIds":["paths/~1v4~1user-updates/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v4~1user-updates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/user-updates","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_46","exampleIds":["paths/~1v4~1user-updates/post/requestBody/content/application~1json/example"]}},"responseCodes":["202","400","401"],"pointer":"/v4/user-updates","href":"users/updatebulkusers","openApiOperationId":"updateBulkUsers","summary":"Update users in bulk"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_46","exampleIds":["paths/~1v4~1user-updates/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_46","exampleIds":["paths/~1v4~1user-updates/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Bulk_User_Update_Response"}},"schemaId":"components/schemas/Bulk_User_Update_Response","headers":{}},{"code":"400","description":"The request is invalid. A required attribute is missing or an attribute did not meet the expected criteria.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1v4~1user-updates/post/responses/400/content/application~1json/examples/missingName","paths/~1v4~1user-updates/post/responses/400/content/application~1json/examples/invalidType"]}},"schemaId":"schema_13","exampleIds":["paths/~1v4~1user-updates/post/responses/400/content/application~1json/examples/missingName","paths/~1v4~1user-updates/post/responses/400/content/application~1json/examples/invalidType"]},{"code":"401","description":"Authentication credentials were not provided or are invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1v4~1user-updates/post/responses/401/content/application~1json/examples/missingCredentials"]}},"schemaId":"schema_13","exampleIds":["paths/~1v4~1user-updates/post/responses/401/content/application~1json/examples/missingCredentials"]}],"pointer":"/paths/~1v4~1user-updates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/Bulk_User_Update_Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Bulk_User_Update_Response"}}},{"code":"400","schemaId":"schema_13","exampleIds":["paths/~1v4~1user-updates/post/responses/400/content/application~1json/examples/missingName","paths/~1v4~1user-updates/post/responses/400/content/application~1json/examples/invalidType"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1v4~1user-updates/post/responses/400/content/application~1json/examples/missingName","paths/~1v4~1user-updates/post/responses/400/content/application~1json/examples/invalidType"]}}},{"code":"401","schemaId":"schema_13","exampleIds":["paths/~1v4~1user-updates/post/responses/401/content/application~1json/examples/missingCredentials"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1v4~1user-updates/post/responses/401/content/application~1json/examples/missingCredentials"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/updatebulkusers"}],"panels":[]}]},"httpPath":"/v4/user-updates"},{"label":"List all bulk user update jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/listbulkuserupdatejobs","routeSlug":"/zephr-api-reference/zephr-admin-api/users/listbulkuserupdatejobs","metadata":{"seo":{"title":"List all bulk user update jobs","description":"Lists all bulk user update jobs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBulkUserUpdateJobs","name":"List all bulk user update jobs","isWebhook":false,"pointer":"/paths/~1v4~1user-updates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all bulk user update jobs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all bulk user update jobs.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/user-updates","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/user-updates","href":"users/listbulkuserupdatejobs","openApiOperationId":"listBulkUserUpdateJobs","summary":"List all bulk user update jobs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Get_Bulk_User_Update_Jobs_Response"}},"schemaId":"components/schemas/Get_Bulk_User_Update_Jobs_Response","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v4~1user-updates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Get_Bulk_User_Update_Jobs_Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Get_Bulk_User_Update_Jobs_Response"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/listbulkuserupdatejobs"}],"panels":[]}]},"httpPath":"/v4/user-updates"},{"label":"Retrieves a bulk user update job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/retrievebulkuserupdatejob","routeSlug":"/zephr-api-reference/zephr-admin-api/users/retrievebulkuserupdatejob","metadata":{"seo":{"title":"Retrieves a bulk user update job","description":"Retrieves the status of a bulk user update job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveBulkUserUpdateJob","name":"Retrieves a bulk user update job","isWebhook":false,"pointer":"/paths/~1v4~1user-updates~1{job_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a bulk user update job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the status of a bulk user update job.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"job_id","in":"path","schemaId":"schema_0","description":"Id of the job.","required":true}],"pointer":"/paths/~1v4~1user-updates~1{job_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/user-updates/{job_id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"job_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/user-updates/{job_id}","href":"users/retrievebulkuserupdatejob","openApiOperationId":"retrieveBulkUserUpdateJob","summary":"Retrieves a bulk user update job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Get_Bulk_User_Update_Job_Response"}},"schemaId":"components/schemas/Get_Bulk_User_Update_Job_Response","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v4~1user-updates~1{job_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Get_Bulk_User_Update_Job_Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Get_Bulk_User_Update_Job_Response"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/retrievebulkuserupdatejob"}],"panels":[]}]},"httpPath":"/v4/user-updates/{job_id}"},{"label":"Create a user segment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/createusersegment","routeSlug":"/zephr-api-reference/zephr-admin-api/users/createusersegment","metadata":{"seo":{"title":"Create a user segment","description":"Creates a new User Segment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUserSegment","name":"Create a user segment","isWebhook":false,"pointer":"/paths/~1v4~1users~1segments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a user segment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new User Segment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_47"}},"schemaId":"schema_47","pointer":"/paths/~1v4~1users~1segments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/users/segments","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_47"}},"responseCodes":["201","400"],"pointer":"/v4/users/segments","href":"users/createusersegment","openApiOperationId":"createUserSegment","summary":"Create a user segment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_47","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_47"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v4~1users~1segments/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/createusersegment"}],"panels":[]}]},"httpPath":"/v4/users/segments"},{"label":"List user segments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/listusersegment","routeSlug":"/zephr-api-reference/zephr-admin-api/users/listusersegment","metadata":{"seo":{"title":"List user segments","description":"Lists all user segments available for users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserSegment","name":"List user segments","isWebhook":false,"pointer":"/paths/~1v4~1users~1segments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user segments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all user segments available for users."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/users/segments","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/users/segments","href":"users/listusersegment","openApiOperationId":"listUserSegment","summary":"List user segments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User_Segments_Response"}},"schemaId":"components/schemas/User_Segments_Response","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v4~1users~1segments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/User_Segments_Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User_Segments_Response"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/listusersegment"}],"panels":[]}]},"httpPath":"/v4/users/segments"},{"label":"Retrieve a user segment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/getusersegment","routeSlug":"/zephr-api-reference/zephr-admin-api/users/getusersegment","metadata":{"seo":{"title":"Retrieve a user segment","description":"Retrieves a user segment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserSegment","name":"Retrieve a user segment","isWebhook":false,"pointer":"/paths/~1v4~1users~1segments~1{segmentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a user segment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a user segment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"segmentId","in":"path","schemaId":"schema_0","description":"Unique User Segment Identifier","required":true}],"pointer":"/paths/~1v4~1users~1segments~1{segmentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/users/segments/{segmentId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"segmentId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/users/segments/{segmentId}","href":"users/getusersegment","openApiOperationId":"getUserSegment","summary":"Retrieve a user segment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User_Segment_Response"}},"schemaId":"components/schemas/User_Segment_Response","headers":{}}],"pointer":"/paths/~1v4~1users~1segments~1{segmentId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/User_Segment_Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User_Segment_Response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getusersegment"}],"panels":[]}]},"httpPath":"/v4/users/segments/{segmentId}"},{"label":"Delete a user segment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/deleteusersegment","routeSlug":"/zephr-api-reference/zephr-admin-api/users/deleteusersegment","metadata":{"seo":{"title":"Delete a user segment","description":"Deletes a user segment by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUserSegment","name":"Delete a user segment","isWebhook":false,"pointer":"/paths/~1v4~1users~1segments~1{segmentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a user segment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a user segment by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"segmentId","in":"path","schemaId":"schema_0","description":"Unique User Segment Identifier","required":true}],"pointer":"/paths/~1v4~1users~1segments~1{segmentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/users/segments/{segmentId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"segmentId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/users/segments/{segmentId}","href":"users/deleteusersegment","openApiOperationId":"deleteUserSegment","summary":"Delete a user segment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}}],"pointer":"/paths/~1v4~1users~1segments~1{segmentId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/deleteusersegment"}],"panels":[]}]},"httpPath":"/v4/users/segments/{segmentId}"},{"label":"List user segments for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/listusersegmentsforuser","routeSlug":"/zephr-api-reference/zephr-admin-api/users/listusersegmentsforuser","metadata":{"seo":{"title":"List user segments for a user","description":"Lists all user segments for a given userId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserSegmentsforUser","name":"List user segments for a user","isWebhook":false,"pointer":"/paths/~1v4~1users~1{userId}~1segments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user segments for a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all user segments for a given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true,"example":"3f589a2d-86ad-4b70-a5df-68dca75a3a21"}],"pointer":"/paths/~1v4~1users~1{userId}~1segments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/users/{userId}/segments","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":"3f589a2d-86ad-4b70-a5df-68dca75a3a21","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/users/{userId}/segments","href":"users/listusersegmentsforuser","openApiOperationId":"listUserSegmentsforUser","summary":"List user segments for a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User_Segments_Response"}},"schemaId":"components/schemas/User_Segments_Response","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v4~1users~1{userId}~1segments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/User_Segments_Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User_Segments_Response"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/listusersegmentsforuser"}],"panels":[]}]},"httpPath":"/v4/users/{userId}/segments"},{"label":"Start an email address update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/startemailaddressupdate","routeSlug":"/zephr-api-reference/zephr-admin-api/users/startemailaddressupdate","metadata":{"seo":{"title":"Start an email address update","description":"Starts an email address update. If the Require Email Verification configuration flag is set, to update a user's email address, first they need to verify their new address. If the Email Change Override feature flag is enabled, the an email with a link to verify the address will be sent to the new address. Otherwise the email will be sent to the old address. If the Require Email Verification configuration flag is not set, this endpoint sets the new email address immediately. If the user has a username and the provided email address is blank, the email address is deleted. If the user does not have a username and the provided email address is blank, a 400 is returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startEmailAddressUpdate","name":"Start an email address update","isWebhook":false,"pointer":"/paths/~1v3~1users~1{user_id}~1update-email/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start an email address update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Starts an email address update. \nIf the Require Email Verification configuration flag is set, to update a user's email address, first they need to verify their new address. If the Email Change Override feature flag is enabled, the an email with a link to verify the address will be sent to the new address. Otherwise the email will be sent to the old address.\nIf the Require Email Verification configuration flag is not set, this endpoint sets the new email address immediately. If the user has a username and the provided email address is blank, the email address is deleted. If the user does not have a username and the provided email address is blank, a 400 is returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1users~1{user_id}~1update-email/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_48"}},"schemaId":"schema_48","pointer":"/paths/~1v3~1users~1{user_id}~1update-email/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/users/{user_id}/update-email","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_48"}},"responseCodes":["201","400","404","409"],"pointer":"/v3/users/{user_id}/update-email","href":"users/startemailaddressupdate","openApiOperationId":"startEmailAddressUpdate","summary":"Start an email address update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_48","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_48"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK. The process to update email started and is potentially already completed, depending on the Email Verification configuration flag. See endpoint description for more information.\n","headers":{}},{"code":"400","description":"Bad Request","headers":{}},{"code":"404","description":"User ID not Found","headers":{}},{"code":"409","description":"Email address already in use","headers":{}}],"pointer":"/paths/~1v3~1users~1{user_id}~1update-email/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/startemailaddressupdate"}],"panels":[]}]},"httpPath":"/v3/users/{user_id}/update-email"},{"label":"Start a password reset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/startpasswordreset","routeSlug":"/zephr-api-reference/zephr-admin-api/users/startpasswordreset","metadata":{"seo":{"title":"Start a password reset","description":"Starts a password reset."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startPasswordReset","name":"Start a password reset","isWebhook":false,"pointer":"/paths/~1v4~1users~1reset/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start a password reset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts a password reset."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IMPORTANT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": To reset a user password, first is required to send a POST to request an email to be sent to the user’s email with a link for the user to click on, so as to verify that they requested this password change."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49","pointer":"/paths/~1v4~1users~1reset/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/users/reset","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_49"}},"responseCodes":["200","400","404"],"pointer":"/v4/users/reset","href":"users/startpasswordreset","openApiOperationId":"startPasswordReset","summary":"Start a password reset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_49"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - The password reset flow has been started successfully","headers":{}},{"code":"400","description":"Bad Request - Incorrect payload was submitted","headers":{}},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found - Site not found with the supplied "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"siteSlug"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or user not found with the supplied email address"},"children":[]}]}]}],"headers":{}}],"pointer":"/paths/~1v4~1users~1reset/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/startpasswordreset"}],"panels":[]}]},"httpPath":"/v4/users/reset"},{"label":"Start a passwordless authentication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/startpasswordlessauthentication","routeSlug":"/zephr-api-reference/zephr-admin-api/users/startpasswordlessauthentication","metadata":{"seo":{"title":"Start a passwordless authentication","description":"Starts a passwordless authentication."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startPasswordlessAuthentication","name":"Start a passwordless authentication","isWebhook":false,"pointer":"/paths/~1v3~1users~1token-exchange/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start a passwordless authentication","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts a passwordless authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IMPORTANT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For passwordless authentication, first is required to send a POST to request an email to be sent to the user’s email with a link for the user to click on to verify his email."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50","pointer":"/paths/~1v3~1users~1token-exchange/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/users/token-exchange","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_50"}},"responseCodes":["201","400"],"pointer":"/v3/users/token-exchange","href":"users/startpasswordlessauthentication","openApiOperationId":"startPasswordlessAuthentication","summary":"Start a passwordless authentication"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_50"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1users~1token-exchange/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/startpasswordlessauthentication"}],"panels":[]}]},"httpPath":"/v3/users/token-exchange"},{"label":"List user sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/listusersessions","routeSlug":"/zephr-api-reference/zephr-admin-api/users/listusersessions","metadata":{"seo":{"title":"List user sessions","description":"Retrieves a list of the user's sessions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserSessions","name":"List user sessions","isWebhook":false,"pointer":"/paths/~1v3~1users~1{user_id}~1sessions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user sessions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of the user's sessions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1users~1{user_id}~1sessions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/users/{user_id}/sessions","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/users/{user_id}/sessions","href":"users/listusersessions","openApiOperationId":"listUserSessions","summary":"List user sessions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51","exampleIds":["paths/~1v3~1users~1{user_id}~1sessions/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_51","exampleIds":["paths/~1v3~1users~1{user_id}~1sessions/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1users~1{user_id}~1sessions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_51","exampleIds":["paths/~1v3~1users~1{user_id}~1sessions/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51","exampleIds":["paths/~1v3~1users~1{user_id}~1sessions/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/listusersessions"}],"panels":[]}]},"httpPath":"/v3/users/{user_id}/sessions"},{"label":"List user accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/listuseraccounts","routeSlug":"/zephr-api-reference/zephr-admin-api/users/listuseraccounts","metadata":{"seo":{"title":"List user accounts","description":"Retrieves a list of the user's accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserAccounts","name":"List user accounts","isWebhook":false,"pointer":"/paths/~1v3~1users~1{user_id}~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of the user's accounts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1users~1{user_id}~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/users/{user_id}/accounts","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/users/{user_id}/accounts","href":"users/listuseraccounts","openApiOperationId":"listUserAccounts","summary":"List user accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_52","exampleIds":["paths/~1v3~1users~1{user_id}~1accounts/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_52","exampleIds":["paths/~1v3~1users~1{user_id}~1accounts/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1users~1{user_id}~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_52","exampleIds":["paths/~1v3~1users~1{user_id}~1accounts/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_52","exampleIds":["paths/~1v3~1users~1{user_id}~1accounts/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/listuseraccounts"}],"panels":[]}]},"httpPath":"/v3/users/{user_id}/accounts"},{"label":"Refresh a access model","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/refreshaccessmodel","routeSlug":"/zephr-api-reference/zephr-admin-api/users/refreshaccessmodel","metadata":{"seo":{"title":"Refresh a access model","description":"Refreshes the user's access model."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"refreshAccessModel","name":"Refresh a access model","isWebhook":false,"pointer":"/paths/~1v3~1users~1{user_id}~1authorization~1refresh/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refresh a access model","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Refreshes the user's access model."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1users~1{user_id}~1authorization~1refresh/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/users/{user_id}/authorization/refresh","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/users/{user_id}/authorization/refresh","href":"users/refreshaccessmodel","openApiOperationId":"refreshAccessModel","summary":"Refresh a access model"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/access_model","exampleIds":["paths/~1v3~1users~1{user_id}~1authorization~1refresh/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/access_model","exampleIds":["paths/~1v3~1users~1{user_id}~1authorization~1refresh/post/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1users~1{user_id}~1authorization~1refresh/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/access_model","exampleIds":["paths/~1v3~1users~1{user_id}~1authorization~1refresh/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/access_model","exampleIds":["paths/~1v3~1users~1{user_id}~1authorization~1refresh/post/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/refreshaccessmodel"}],"panels":[]}]},"httpPath":"/v3/users/{user_id}/authorization/refresh"},{"label":"Reset a legacy password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/users/resetlegacypassword","routeSlug":"/zephr-api-reference/zephr-admin-api/users/resetlegacypassword","metadata":{"seo":{"title":"Reset a legacy password","description":"Sets the current password to an empty string, also sets the legacy password to the provided string."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resetLegacyPassword","name":"Reset a legacy password","isWebhook":false,"pointer":"/paths/~1v3~1users~1{user_Id}~1legacyPassword/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset a legacy password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sets the current password to an empty string, also sets the legacy password to the provided string."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_Id","in":"path","schemaId":"schema_0","description":"Unique User identifier","required":true}],"pointer":"/paths/~1v3~1users~1{user_Id}~1legacyPassword/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/users/{user_Id}/legacyPassword","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"user_Id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/users/{user_Id}/legacyPassword","href":"users/resetlegacypassword","openApiOperationId":"resetLegacyPassword","summary":"Reset a legacy password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-user-response","exampleIds":["paths/~1v3~1users~1{user_Id}~1legacyPassword/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/admin-user-response","exampleIds":["paths/~1v3~1users~1{user_Id}~1legacyPassword/post/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1users~1{user_Id}~1legacyPassword/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/admin-user-response","exampleIds":["paths/~1v3~1users~1{user_Id}~1legacyPassword/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin-user-response","exampleIds":["paths/~1v3~1users~1{user_Id}~1legacyPassword/post/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/resetlegacypassword"}],"panels":[]}]},"httpPath":"/v3/users/{user_Id}/legacyPassword"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains operations on the User resource."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Attributes object contains the custom-defined attributes for a user."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/zephr/integration/users/v1/users","summary":"Delete an end user by primary ID or foreign key","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/deleteuserbyprimaryorforeignkey","deprecated":false},{"title":"/v3/users/{userId}/foreign-key/update/{key}","summary":"Insert a foreign key","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/upsertforeignkey","deprecated":false},{"title":"/v4/users/{userId}/foreign-key/{key}/{system}","summary":"Delete a foreign key","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/deleteforeignkey","deprecated":false},{"title":"/v3/users","summary":"List users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/listusers","deprecated":false},{"title":"/v3/users","summary":"Create a user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/createuser","deprecated":false},{"title":"/v3/users/{user_id}","summary":"Retrieve a user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getuser","deprecated":false},{"title":"/v3/users/{user_id}","summary":"Delete a user","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/deleteuser","deprecated":false},{"title":"/v3/users/{user_id}/attributes","summary":"Update all user attributes","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/replaceuserattributes","deprecated":false},{"title":"/v3/users/{user_id}/attributes","summary":"Update user attributes","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/users/updateuserattribute","deprecated":false},{"title":"/v3/users/{user_id}/profile/{app_id}","summary":"Retrieve Extended User Profiles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/paths/~1v3~1users~1{user_id}~1profile~1{app_id}/get","deprecated":false},{"title":"/v4/user-updates","summary":"Update users in bulk","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/updatebulkusers","deprecated":false},{"title":"/v4/user-updates","summary":"List all bulk user update jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/listbulkuserupdatejobs","deprecated":false},{"title":"/v4/user-updates/{job_id}","summary":"Retrieves a bulk user update job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/retrievebulkuserupdatejob","deprecated":false},{"title":"/v4/users/segments","summary":"Create a user segment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/createusersegment","deprecated":false},{"title":"/v4/users/segments","summary":"List user segments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/listusersegment","deprecated":false},{"title":"/v4/users/segments/{segmentId}","summary":"Retrieve a user segment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getusersegment","deprecated":false},{"title":"/v4/users/segments/{segmentId}","summary":"Delete a user segment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/deleteusersegment","deprecated":false},{"title":"/v4/users/{userId}/segments","summary":"List user segments for a user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/listusersegmentsforuser","deprecated":false},{"title":"/v3/users/{user_id}/update-email","summary":"Start an email address update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/startemailaddressupdate","deprecated":false},{"title":"/v4/users/reset","summary":"Start a password reset","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/startpasswordreset","deprecated":false},{"title":"/v3/users/token-exchange","summary":"Start a passwordless authentication","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/startpasswordlessauthentication","deprecated":false},{"title":"/v3/users/{user_id}/sessions","summary":"List user sessions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/listusersessions","deprecated":false},{"title":"/v3/users/{user_id}/accounts","summary":"List user accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/listuseraccounts","deprecated":false},{"title":"/v3/users/{user_id}/authorization/refresh","summary":"Refresh a access model","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/refreshaccessmodel","deprecated":false},{"title":"/v3/users/{user_Id}/legacyPassword","summary":"Reset a legacy password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/resetlegacypassword","deprecated":false}]}]}]}]}},{"type":"group","label":"V4 Session","link":"/zephr-api-reference/zephr-admin-api/v4-session","routeSlug":"/zephr-api-reference/zephr-admin-api/v4-session","items":[{"label":"Create a new session under a given site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/v4-session/createnewsessionundergivensite","routeSlug":"/zephr-api-reference/zephr-admin-api/v4-session/createnewsessionundergivensite","metadata":{"seo":{"title":"Create a new session under a given site","description":"Creates a new session under a given site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNewSessionUnderGivenSite","name":"Create a new session under a given site","isWebhook":false,"pointer":"/paths/~1v4~1sessions~1{site}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new session under a given site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new session under a given site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"site","in":"path","schemaId":"schema_0","description":"The site ID","required":true}],"pointer":"/paths/~1v4~1sessions~1{site}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_3"}},"schemaId":"schema_3","pointer":"/paths/~1v4~1sessions~1{site}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/sessions/{site}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"site","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_3"}},"responseCodes":["201","400","401","404"],"pointer":"/v4/sessions/{site}","href":"v4-session/createnewsessionundergivensite","openApiOperationId":"createNewSessionUnderGivenSite","summary":"Create a new session under a given site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_3","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_3"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/session","exampleIds":["paths/~1v4~1sessions~1{site}/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/session","exampleIds":["paths/~1v4~1sessions~1{site}/post/responses/201/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request","headers":{}},{"code":"401","description":"Unauthorized","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v4~1sessions~1{site}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/session","exampleIds":["paths/~1v4~1sessions~1{site}/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/session","exampleIds":["paths/~1v4~1sessions~1{site}/post/responses/201/content/application~1json/examples/response"]}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v4-session/createnewsessionundergivensite"}],"panels":[]}]},"httpPath":"/v4/sessions/{site}"},{"label":"Look up a session under a given site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/v4-session/lookupsessionundergivensite","routeSlug":"/zephr-api-reference/zephr-admin-api/v4-session/lookupsessionundergivensite","metadata":{"seo":{"title":"Look up a session under a given site","description":"This endpoint allows you to access specific session details for a particular site. By providing the unique identifiers for the site and the session, you can retrieve detailed information about that session. This information can include the session's start time, end time, current status, and any associated user data. The exact content of the response will depend on the specific session and site identifiers provided in the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"lookupSessionUnderGivenSite","name":"Look up a session under a given site","isWebhook":false,"pointer":"/paths/~1v4~1sessions~1{site}~1{sessionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Look up a session under a given site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to access specific session details for a particular site. By providing the unique identifiers for the site and the session, you can retrieve detailed information about that session. This information can include the session's start time, end time, current status, and any associated user data. The exact content of the response will depend on the specific session and site identifiers provided in the request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"site","in":"path","schemaId":"schema_0","description":"The unique site identifier within the tenant.","required":true},{"name":"sessionId","in":"path","schemaId":"schema_0","description":"Unique session identifier assigned to each session, enabling precise identification and retrieval of session-related information within the API.","required":true}],"pointer":"/paths/~1v4~1sessions~1{site}~1{sessionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/sessions/{site}/{sessionId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"site","in":"path","required":true,"schemaId":"schema_0"},{"name":"sessionId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v4/sessions/{site}/{sessionId}","href":"v4-session/lookupsessionundergivensite","openApiOperationId":"lookupSessionUnderGivenSite","summary":"Look up a session under a given site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. Returns the session details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/session-lookup"}},"schemaId":"components/schemas/session-lookup","headers":{}},{"code":"401","description":"Unauthorized. No valid authentication was provided.","headers":{}},{"code":"404","description":"No session found. The site or the session ID is invalid.","headers":{}}],"pointer":"/paths/~1v4~1sessions~1{site}~1{sessionId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/session-lookup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/session-lookup"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v4-session/lookupsessionundergivensite"}],"panels":[]}]},"httpPath":"/v4/sessions/{site}/{sessionId}"},{"label":"Delete a session under a given site","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/v4-session/deletesessionundergivensite","routeSlug":"/zephr-api-reference/zephr-admin-api/v4-session/deletesessionundergivensite","metadata":{"seo":{"title":"Delete a session under a given site","description":"This endpoint is used to delete a specific session for a given site. You need to provide the unique identifiers for the site and the session. This operation is useful when you want to manually end a session before it naturally expires."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSessionUnderGivenSite","name":"Delete a session under a given site","isWebhook":false,"pointer":"/paths/~1v4~1sessions~1{site}~1{sessionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a session under a given site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint is used to delete a specific session for a given site. You need to provide the unique identifiers for the site and the session. This operation is useful when you want to manually end a session before it naturally expires."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"site","in":"path","schemaId":"schema_0","description":"The unique site identifier within the tenant.","required":true},{"name":"sessionId","in":"path","schemaId":"schema_0","description":"Unique session identifier assigned to each session, enabling precise identification and retrieval of session-related information within the API.","required":true}],"pointer":"/paths/~1v4~1sessions~1{site}~1{sessionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/sessions/{site}/{sessionId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"site","in":"path","required":true,"schemaId":"schema_0"},{"name":"sessionId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v4/sessions/{site}/{sessionId}","href":"v4-session/deletesessionundergivensite","openApiOperationId":"deleteSessionUnderGivenSite","summary":"Delete a session under a given site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The session was successfully deleted.","headers":{}},{"code":"401","description":"Unauthorized. No valid authentication was provided.","headers":{}},{"code":"404","description":"No session found. The site or the session ID is invalid.","headers":{}}],"pointer":"/paths/~1v4~1sessions~1{site}~1{sessionId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v4-session/deletesessionundergivensite"}],"panels":[]}]},"httpPath":"/v4/sessions/{site}/{sessionId}"},{"label":"Create an anonymous session under a given site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/v4-session/createanonymoussessionundergivensite","routeSlug":"/zephr-api-reference/zephr-admin-api/v4-session/createanonymoussessionundergivensite","metadata":{"seo":{"title":"Create an anonymous session under a given site","description":"Creates an anonymous session under a given site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAnonymousSessionUnderGivenSite","name":"Create an anonymous session under a given site","isWebhook":false,"pointer":"/paths/~1v4~1anonymous-sessions~1{site}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an anonymous session under a given site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an anonymous session under a given site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"site","in":"path","schemaId":"schema_0","description":"The site ID","required":true}],"pointer":"/paths/~1v4~1anonymous-sessions~1{site}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/anonymous-sessions/{site}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"site","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v4/anonymous-sessions/{site}","href":"v4-session/createanonymoussessionundergivensite","openApiOperationId":"createAnonymousSessionUnderGivenSite","summary":"Create an anonymous session under a given site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/session","exampleIds":["paths/~1v4~1anonymous-sessions~1{site}/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/session","exampleIds":["paths/~1v4~1anonymous-sessions~1{site}/post/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"401","description":"Unauthorized","headers":{}}],"pointer":"/paths/~1v4~1anonymous-sessions~1{site}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/session","exampleIds":["paths/~1v4~1anonymous-sessions~1{site}/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/session","exampleIds":["paths/~1v4~1anonymous-sessions~1{site}/post/responses/200/content/application~1json/examples/response"]}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v4-session/createanonymoussessionundergivensite"}],"panels":[]}]},"httpPath":"/v4/anonymous-sessions/{site}"}],"content":{"contentType":"group","meta":{"name":"V4 Session"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"V4 Session","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Session."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/sessions/{site}","summary":"Create a new session under a given site","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v4-session/createnewsessionundergivensite","deprecated":false},{"title":"/v4/sessions/{site}/{sessionId}","summary":"Look up a session under a given site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v4-session/lookupsessionundergivensite","deprecated":false},{"title":"/v4/sessions/{site}/{sessionId}","summary":"Delete a session under a given site","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/v4-session/deletesessionundergivensite","deprecated":false},{"title":"/v4/anonymous-sessions/{site}","summary":"Create an anonymous session under a given site","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v4-session/createanonymoussessionundergivensite","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhook","link":"/zephr-api-reference/zephr-admin-api/webhook","routeSlug":"/zephr-api-reference/zephr-admin-api/webhook","items":[{"label":"List webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/webhook/listwebhooks","routeSlug":"/zephr-api-reference/zephr-admin-api/webhook/listwebhooks","metadata":{"seo":{"title":"List webhooks","description":"Retrieves a list of webhooks wrapped in the element \"results\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWebhooks","name":"List webhooks","isWebhook":false,"pointer":"/paths/~1v3~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of webhooks wrapped in the element \"results\"."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/webhooks","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/webhooks","href":"webhook/listwebhooks","openApiOperationId":"listWebhooks","summary":"List webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook-responses-container","exampleIds":["paths/~1v3~1webhooks/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/webhook-responses-container","exampleIds":["paths/~1v3~1webhooks/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/webhook-responses-container","exampleIds":["paths/~1v3~1webhooks/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook-responses-container","exampleIds":["paths/~1v3~1webhooks/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/listwebhooks"}],"panels":[]}]},"httpPath":"/v3/webhooks"},{"label":"Create a webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/webhook/createwebhook","routeSlug":"/zephr-api-reference/zephr-admin-api/webhook/createwebhook","metadata":{"seo":{"title":"Create a webhook","description":"Creates a Webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhook","name":"Create a webhook","isWebhook":false,"pointer":"/paths/~1v3~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a Webhook."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_53"}},"schemaId":"schema_53","pointer":"/paths/~1v3~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/webhooks","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_53"}},"responseCodes":["201","400"],"pointer":"/v3/webhooks","href":"webhook/createwebhook","openApiOperationId":"createWebhook","summary":"Create a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_53","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_53"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1webhooks/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/createwebhook"}],"panels":[]}]},"httpPath":"/v3/webhooks"},{"label":"Retrieve a webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/webhook/getwebhook","routeSlug":"/zephr-api-reference/zephr-admin-api/webhook/getwebhook","metadata":{"seo":{"title":"Retrieve a webhook","description":"Retrieves a webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhook","name":"Retrieve a webhook","isWebhook":false,"pointer":"/paths/~1v3~1webhooks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a webhook."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Webhook identifier","required":true}],"pointer":"/paths/~1v3~1webhooks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/webhooks/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/webhooks/{id}","href":"webhook/getwebhook","openApiOperationId":"getWebhook","summary":"Retrieve a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhooks-responses","exampleIds":["paths/~1v3~1webhooks~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/webhooks-responses","exampleIds":["paths/~1v3~1webhooks~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1webhooks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/webhooks-responses","exampleIds":["paths/~1v3~1webhooks~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhooks-responses","exampleIds":["paths/~1v3~1webhooks~1{id}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/getwebhook"}],"panels":[]}]},"httpPath":"/v3/webhooks/{id}"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/webhook/deletewebhook","routeSlug":"/zephr-api-reference/zephr-admin-api/webhook/deletewebhook","metadata":{"seo":{"title":"Delete a webhook","description":"Deletes a webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhook","name":"Delete a webhook","isWebhook":false,"pointer":"/paths/~1v3~1webhooks~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a webhook."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Webhook identifier","required":true}],"pointer":"/paths/~1v3~1webhooks~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/webhooks/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/webhooks/{id}","href":"webhook/deletewebhook","openApiOperationId":"deleteWebhook","summary":"Delete a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1webhooks~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/deletewebhook"}],"panels":[]}]},"httpPath":"/v3/webhooks/{id}"},{"label":"Update a webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/webhook/updatewebhook","routeSlug":"/zephr-api-reference/zephr-admin-api/webhook/updatewebhook","metadata":{"seo":{"title":"Update a webhook","description":"Updates a webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebhook","name":"Update a webhook","isWebhook":false,"pointer":"/paths/~1v3~1webhooks~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a webhook."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Webhook identifier","required":true}],"pointer":"/paths/~1v3~1webhooks~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_54"}},"schemaId":"schema_54","pointer":"/paths/~1v3~1webhooks~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/webhooks/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_54"}},"responseCodes":["200","400"],"pointer":"/v3/webhooks/{id}","href":"webhook/updatewebhook","openApiOperationId":"updateWebhook","summary":"Update a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_54","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_54"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1webhooks~1{id}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/updatewebhook"}],"panels":[]}]},"httpPath":"/v3/webhooks/{id}"}],"content":{"contentType":"group","meta":{"name":"Webhook"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Webhook."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/webhooks","summary":"List webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook/listwebhooks","deprecated":false},{"title":"/v3/webhooks","summary":"Create a webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook/createwebhook","deprecated":false},{"title":"/v3/webhooks/{id}","summary":"Retrieve a webhook","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook/getwebhook","deprecated":false},{"title":"/v3/webhooks/{id}","summary":"Delete a webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhook/deletewebhook","deprecated":false},{"title":"/v3/webhooks/{id}","summary":"Update a webhook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/webhook/updatewebhook","deprecated":false}]}]}]}]}},{"type":"group","label":"Account","link":"/zephr-api-reference/zephr-admin-api/account","routeSlug":"/zephr-api-reference/zephr-admin-api/account","items":[{"label":"List accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account/listaccounts","routeSlug":"/zephr-api-reference/zephr-admin-api/account/listaccounts","metadata":{"seo":{"title":"List accounts","description":"Retrieves a paginated list of accounts in results according to  the passed in rpp, page and search parameters alongside  the total number of items matching the search query (total)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAccounts","name":"List accounts","isWebhook":false,"pointer":"/paths/~1v3~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a paginated list of accounts in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" according to  the passed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rpp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters alongside  the total number of items matching the search query ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rpp","in":"query","schemaId":"schema_55","description":"The number of results per page you want to retrieve."},{"name":"page","in":"query","schemaId":"schema_55","description":"The page number for which you want to retrieve results."},{"name":"search","in":"query","schemaId":"schema_56","description":"The search query that searches accounts by their names"}],"pointer":"/paths/~1v3~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/accounts","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[{"name":"rpp","in":"query","example":15,"schemaId":"schema_55"},{"name":"page","in":"query","example":15,"schemaId":"schema_55"},{"name":"search","in":"query","example":"My account","schemaId":"schema_56"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v3/accounts","href":"account/listaccounts","openApiOperationId":"listAccounts","summary":"List accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Accounts have been retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/simple_account_bodies","exampleIds":["paths/~1v3~1accounts/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/simple_account_bodies","exampleIds":["paths/~1v3~1accounts/get/responses/200/content/application~1json/examples/response"],"headers":{}}],"pointer":"/paths/~1v3~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/simple_account_bodies","exampleIds":["paths/~1v3~1accounts/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/simple_account_bodies","exampleIds":["paths/~1v3~1accounts/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/listaccounts"}],"panels":[]}]},"httpPath":"/v3/accounts"},{"label":"Create an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account/createaccount","routeSlug":"/zephr-api-reference/zephr-admin-api/account/createaccount","metadata":{"seo":{"title":"Create an account","description":"Creates an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAccount","name":"Create an account","isWebhook":false,"pointer":"/paths/~1v3~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Create_AccountBody"}},"schemaId":"components/schemas/Create_AccountBody","pointer":"/paths/~1v3~1accounts/post/requestBody","description":"Description"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/accounts","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Create_AccountBody"}},"responseCodes":["201","400"],"pointer":"/v3/accounts","href":"account/createaccount","openApiOperationId":"createAccount","summary":"Create an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"components/schemas/Create_AccountBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Create_AccountBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1accounts/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/createaccount"}],"panels":[]}]},"httpPath":"/v3/accounts"},{"label":"Retrieve an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account/getaccount","routeSlug":"/zephr-api-reference/zephr-admin-api/account/getaccount","metadata":{"seo":{"title":"Retrieve an account","description":"Retrieves an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccount","name":"Retrieve an account","isWebhook":false,"pointer":"/paths/~1v3~1accounts~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Account identifier","required":true}],"pointer":"/paths/~1v3~1accounts~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/accounts/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/accounts/{id}","href":"account/getaccount","openApiOperationId":"getAccount","summary":"Retrieve an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response_accountbody","exampleIds":["paths/~1v3~1accounts~1{id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/response_accountbody","exampleIds":["paths/~1v3~1accounts~1{id}/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Account id not found"}],"pointer":"/paths/~1v3~1accounts~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/response_accountbody","exampleIds":["paths/~1v3~1accounts~1{id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response_accountbody","exampleIds":["paths/~1v3~1accounts~1{id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/getaccount"}],"panels":[]}]},"httpPath":"/v3/accounts/{id}"},{"label":"Delete an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account/deleteaccount","routeSlug":"/zephr-api-reference/zephr-admin-api/account/deleteaccount","metadata":{"seo":{"title":"Delete an account","description":"Deletes an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAccount","name":"Delete an account","isWebhook":false,"pointer":"/paths/~1v3~1accounts~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Account identifier","required":true}],"pointer":"/paths/~1v3~1accounts~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/accounts/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v3/accounts/{id}","href":"account/deleteaccount","openApiOperationId":"deleteAccount","summary":"Delete an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v3~1accounts~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/deleteaccount"}],"panels":[]}]},"httpPath":"/v3/accounts/{id}"},{"label":"Update an account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account/updateaccount","routeSlug":"/zephr-api-reference/zephr-admin-api/account/updateaccount","metadata":{"seo":{"title":"Update an account","description":"Updates an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAccount","name":"Update an account","isWebhook":false,"pointer":"/paths/~1v3~1accounts~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Account identifier","required":true}],"pointer":"/paths/~1v3~1accounts~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Create_AccountBody"}},"schemaId":"components/schemas/Create_AccountBody","pointer":"/paths/~1v3~1accounts~1{id}/put/requestBody","description":"Description"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/accounts/{id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Create_AccountBody"}},"responseCodes":["201","400"],"pointer":"/v3/accounts/{id}","href":"account/updateaccount","openApiOperationId":"updateAccount","summary":"Update an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"components/schemas/Create_AccountBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Create_AccountBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1accounts~1{id}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/updateaccount"}],"panels":[]}]},"httpPath":"/v3/accounts/{id}"},{"label":"Retrieve an account for V4","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account/getaccountv4","routeSlug":"/zephr-api-reference/zephr-admin-api/account/getaccountv4","metadata":{"seo":{"title":"Retrieve an account for V4","description":"Retrieves an V4 account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountV4","name":"Retrieve an account for V4","isWebhook":false,"pointer":"/paths/~1v4~1accounts~1{account_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an account for V4","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an V4 account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_0","description":"Unique Account identifier V4","required":true}],"pointer":"/paths/~1v4~1accounts~1{account_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/accounts/{account_id}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/accounts/{account_id}","href":"account/getaccountv4","openApiOperationId":"getAccountV4","summary":"Retrieve an account for V4"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response_accountbody","exampleIds":["paths/~1v4~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/response_accountbody","exampleIds":["paths/~1v4~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1v4~1accounts~1{account_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/response_accountbody","exampleIds":["paths/~1v4~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response_accountbody","exampleIds":["paths/~1v4~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/getaccountv4"}],"panels":[]}]},"httpPath":"/v4/accounts/{account_id}"},{"label":"List accounts for v4","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/account/listaccountsv4","routeSlug":"/zephr-api-reference/zephr-admin-api/account/listaccountsv4","metadata":{"seo":{"title":"List accounts for v4","description":"Retrieves a list of accounts for V4."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAccountsV4","name":"List accounts for v4","isWebhook":false,"pointer":"/paths/~1v4~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List accounts for v4","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of accounts for V4."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/accounts","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/accounts","href":"account/listaccountsv4","openApiOperationId":"listAccountsV4","summary":"List accounts for v4"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/account_bodies","exampleIds":["paths/~1v4~1accounts/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/account_bodies","exampleIds":["paths/~1v4~1accounts/get/responses/200/content/application~1json/examples/response"]}],"pointer":"/paths/~1v4~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/account_bodies","exampleIds":["paths/~1v4~1accounts/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/account_bodies","exampleIds":["paths/~1v4~1accounts/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/listaccountsv4"}],"panels":[]}]},"httpPath":"/v4/accounts"}],"content":{"contentType":"group","meta":{"name":"Account"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account","showPageActions":true},{"nodeType":"markdoc","content":"Actions on resource Account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/accounts","summary":"List accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/listaccounts","deprecated":false},{"title":"/v3/accounts","summary":"Create an account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account/createaccount","deprecated":false},{"title":"/v3/accounts/{id}","summary":"Retrieve an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/getaccount","deprecated":false},{"title":"/v3/accounts/{id}","summary":"Delete an account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account/deleteaccount","deprecated":false},{"title":"/v3/accounts/{id}","summary":"Update an account","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account/updateaccount","deprecated":false},{"title":"/v4/accounts/{account_id}","summary":"Retrieve an account for V4","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/getaccountv4","deprecated":false},{"title":"/v4/accounts","summary":"List accounts for v4","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/listaccountsv4","deprecated":false}]}]}]}]}},{"type":"group","label":"Health Check","link":"/zephr-api-reference/zephr-admin-api/health-check","routeSlug":"/zephr-api-reference/zephr-admin-api/health-check","items":[{"label":"Check availability of the origin","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/health-check/paths/~1v3~1healthchecks~1origin/get","routeSlug":"/zephr-api-reference/zephr-admin-api/health-check/paths/~1v3~1healthchecks~1origin/get","metadata":{"seo":{"title":"Check availability of the origin","description":"Sends a request to the origin site to verify availability."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Check availability of the origin","isWebhook":false,"pointer":"/paths/~1v3~1healthchecks~1origin/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check availability of the origin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends a request to the origin site to verify availability."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"cookies","label":"Cookies","labelTranslationKey":"cookie","parameters":[{"name":"tenantId","in":"cookie","schemaId":"schema_0","required":true}],"pointer":"/paths/~1v3~1healthchecks~1origin/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/healthchecks/origin","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[{"name":"tenantId","in":"cookie","required":true,"schemaId":"schema_0"}]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","500","503"],"pointer":"/v3/healthchecks/origin","href":"health-check/paths/~1v3~1healthchecks~1origin/get","summary":"Check availability of the origin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Returned when origin is returning available","headers":{}},{"code":"500","description":"Internal Server Error","headers":{}},{"code":"503","description":"Service Unavailable - The V3 console doesn't handle a 401 response from this endpoint properly","headers":{}}],"pointer":"/paths/~1v3~1healthchecks~1origin/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/health-check/paths/~1v3~1healthchecks~1origin/get"}],"panels":[]}]},"httpPath":"/v3/healthchecks/origin"}],"content":{"contentType":"group","meta":{"name":"Health Check"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Health Check","showPageActions":true},{"nodeType":"markdoc","content":"Actions on Health checks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/healthchecks/origin","summary":"Check availability of the origin","prefix":{"name":"get","color":"get"},"badges":[],"link":"/health-check/paths/~1v3~1healthchecks~1origin/get","deprecated":false}]}]}]}]}},{"type":"group","label":"System Resources","link":"/zephr-api-reference/zephr-admin-api/system-resources","routeSlug":"/zephr-api-reference/zephr-admin-api/system-resources","items":[{"label":"Update system resource","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/system-resources/paths/~1v4~1resources~1{resourceid}~1content/put","routeSlug":"/zephr-api-reference/zephr-admin-api/system-resources/paths/~1v4~1resources~1{resourceid}~1content/put","metadata":{"seo":{"title":"Update system resource","description":"Update system resource by provided resourceId"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update system resource","isWebhook":false,"pointer":"/paths/~1v4~1resources~1{resourceId}~1content/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update system resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update system resource by provided resourceId"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resourceId","in":"path","schemaId":"schema_0","description":"Unique Resource identifier","required":true}],"pointer":"/paths/~1v4~1resources~1{resourceId}~1content/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/resources/{resourceId}/content","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"resourceId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/resources/{resourceId}/content","href":"system-resources/paths/~1v4~1resources~1{resourceid}~1content/put","summary":"Update system resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57","headers":{}},{"code":"404","description":"Cannot find system resource with the provided ID","headers":{}}],"pointer":"/paths/~1v4~1resources~1{resourceId}~1content/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/system-resources/paths/~1v4~1resources~1{resourceid}~1content/put"}],"panels":[]}]},"httpPath":"/v4/resources/{resourceId}/content"}],"content":{"contentType":"group","meta":{"name":"System Resources"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"System Resources","showPageActions":true},{"nodeType":"markdoc","content":"Actions on system resources."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/resources/{resourceId}/content","summary":"Update system resource","prefix":{"name":"put","color":"put"},"badges":[],"link":"/system-resources/paths/~1v4~1resources~1{resourceid}~1content/put","deprecated":false}]}]}]}]}},{"type":"group","label":"External Templates","link":"/zephr-api-reference/zephr-admin-api/external-template","routeSlug":"/zephr-api-reference/zephr-admin-api/external-template","items":[],"content":{"contentType":"group","meta":{"name":"External Template"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Templates","showPageActions":true},{"nodeType":"markdoc","content":"External Templates."}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-template"}],"panels":[]}]}},{"type":"group","label":"Accounts","link":"/zephr-api-reference/zephr-admin-api/accounts","routeSlug":"/zephr-api-reference/zephr-admin-api/accounts","items":[{"label":"Post an account grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/accounts/postaccountbulking","routeSlug":"/zephr-api-reference/zephr-admin-api/accounts/postaccountbulking","metadata":{"seo":{"title":"Post an account grant","description":"Adding account users to company account by email domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAccountBulking","name":"Post an account grant","isWebhook":false,"pointer":"/paths/~1v4~1accounts~1{accountId}~1users/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post an account grant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adding account users to company account by email domain."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_0","description":"Unique Account Company identifier","required":true,"example":"3f589a2d-86ad-4b70-a5df-68dca75a3a21"}],"pointer":"/paths/~1v4~1accounts~1{accountId}~1users/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/accounts/{accountId}/users","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"example":"3f589a2d-86ad-4b70-a5df-68dca75a3a21","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["202","409","500"],"pointer":"/v4/accounts/{accountId}/users","href":"accounts/postaccountbulking","openApiOperationId":"postAccountBulking","summary":"Post an account grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK - Adding account users to company account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was successful"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/add-bulk-account-users-by-domains","exampleIds":["paths/~1v4~1accounts~1{accountId}~1users/post/responses/202/content/application~1json/examples/response"]}},"schemaId":"components/schemas/add-bulk-account-users-by-domains","exampleIds":["paths/~1v4~1accounts~1{accountId}~1users/post/responses/202/content/application~1json/examples/response"],"headers":{}},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict - Cannot add account users to company account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]}]}]}],"headers":{}},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal Error - Failed to bulk add account users for account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountId"},"children":[]}]}]}],"headers":{}}],"pointer":"/paths/~1v4~1accounts~1{accountId}~1users/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/add-bulk-account-users-by-domains","exampleIds":["paths/~1v4~1accounts~1{accountId}~1users/post/responses/202/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/add-bulk-account-users-by-domains","exampleIds":["paths/~1v4~1accounts~1{accountId}~1users/post/responses/202/content/application~1json/examples/response"]}}},{"code":"409"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/postaccountbulking"}],"panels":[]}]},"httpPath":"/v4/accounts/{accountId}/users"}],"content":{"contentType":"group","meta":{"name":"Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/accounts/{accountId}/users","summary":"Post an account grant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounts/postaccountbulking","deprecated":false}]}]}]}]}},{"type":"group","label":"Request Rules Version","link":"/zephr-api-reference/zephr-admin-api/request-rules-version","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules-version","items":[{"label":"Create a request rule version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/request-rules-version/createrequestruleversion","routeSlug":"/zephr-api-reference/zephr-admin-api/request-rules-version/createrequestruleversion","metadata":{"seo":{"title":"Create a request rule version","description":"Create a request rule version"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRequestRuleVersion","name":"Create a request rule version","isWebhook":false,"pointer":"/paths/~1v3~1request-rules~1{id}~1versions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a request rule version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a request rule version"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Unique Request Rule identifier","required":true}],"pointer":"/paths/~1v3~1request-rules~1{id}~1versions/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/request-rules/{id}/versions","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v3/request-rules/{id}/versions","href":"request-rules-version/createrequestruleversion","openApiOperationId":"createRequestRuleVersion","summary":"Create a request rule version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/request_rules_object","exampleIds":["paths/~1v3~1request-rules~1{id}~1versions/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/request_rules_object","exampleIds":["paths/~1v3~1request-rules~1{id}~1versions/post/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"400","description":"Bad Request","headers":{}}],"pointer":"/paths/~1v3~1request-rules~1{id}~1versions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/request_rules_object","exampleIds":["paths/~1v3~1request-rules~1{id}~1versions/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/request_rules_object","exampleIds":["paths/~1v3~1request-rules~1{id}~1versions/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-rules-version/createrequestruleversion"}],"panels":[]}]},"httpPath":"/v3/request-rules/{id}/versions"}],"content":{"contentType":"group","meta":{"name":"Request Rules Version"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request Rules Version","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/request-rules/{id}/versions","summary":"Create a request rule version","prefix":{"name":"post","color":"post"},"badges":[],"link":"/request-rules-version/createrequestruleversion","deprecated":false}]}]}]}]}},{"label":"Fetch external template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/other/fetchexternaltemplate","routeSlug":"/zephr-api-reference/zephr-admin-api/other/fetchexternaltemplate","metadata":{"seo":{"title":"Fetch external template","description":"Fetch External Template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fetchExternalTemplate","name":"Fetch external template","isWebhook":false,"pointer":"/paths/~1zephr~1public~1template-components~1v1~1template-components~1{templateConfigId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch external template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch External Template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateConfigId","in":"path","schemaId":"schema_0","description":"Unique External Template identifier","required":true}],"pointer":"/paths/~1zephr~1public~1template-components~1v1~1template-components~1{templateConfigId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/zephr/public/template-components/v1/template-components/{templateConfigId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"templateConfigId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/zephr/public/template-components/v1/template-components/{templateConfigId}","href":"other/fetchexternaltemplate","openApiOperationId":"fetchExternalTemplate","summary":"Fetch external template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0","exampleIds":["paths/~1zephr~1public~1template-components~1v1~1template-components~1{templateConfigId}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_0","exampleIds":["paths/~1zephr~1public~1template-components~1v1~1template-components~1{templateConfigId}/get/responses/200/content/application~1json/examples/response"],"headers":{}},{"code":"404","description":"Not Found","headers":{}}],"pointer":"/paths/~1zephr~1public~1template-components~1v1~1template-components~1{templateConfigId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_0","exampleIds":["paths/~1zephr~1public~1template-components~1v1~1template-components~1{templateConfigId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0","exampleIds":["paths/~1zephr~1public~1template-components~1v1~1template-components~1{templateConfigId}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/fetchexternaltemplate"}],"panels":[]}]},"httpPath":"/zephr/public/template-components/v1/template-components/{templateConfigId}"},{"type":"group","label":"Pages","link":"/zephr-api-reference/zephr-admin-api/pages","routeSlug":"/zephr-api-reference/zephr-admin-api/pages","items":[{"label":"Generates an S3 upload URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/pages/generatepageuploadurl","routeSlug":"/zephr-api-reference/zephr-admin-api/pages/generatepageuploadurl","metadata":{"seo":{"title":"Generates an S3 upload URL","description":"Generates a presigned S3 URL that can be used to upload a logo."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generatePageUploadURL","name":"Generates an S3 upload URL","isWebhook":false,"pointer":"/paths/~1v4~1pages~1upload-url/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates an S3 upload URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generates a presigned S3 URL that can be used to upload a logo."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/pages/upload-url","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["201"],"pointer":"/v4/pages/upload-url","href":"pages/generatepageuploadurl","openApiOperationId":"generatePageUploadURL","summary":"Generates an S3 upload URL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK - An upload URL has successfully been generated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58"}},"schemaId":"schema_58","headers":{}}],"pointer":"/paths/~1v4~1pages~1upload-url/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_58","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/generatepageuploadurl"}],"panels":[]}]},"httpPath":"/v4/pages/upload-url"}],"content":{"contentType":"group","meta":{"name":"Pages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pages","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/pages/upload-url","summary":"Generates an S3 upload URL","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pages/generatepageuploadurl","deprecated":false}]}]}]}]}},{"type":"group","label":"Dynamic Offer Promo code redemption","link":"/zephr-api-reference/zephr-admin-api/dynamic-offer-promo-code-redemption","routeSlug":"/zephr-api-reference/zephr-admin-api/dynamic-offer-promo-code-redemption","items":[{"label":"Process promo code redemptions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/dynamic-offer-promo-code-redemption/processpromocoderedemptions","routeSlug":"/zephr-api-reference/zephr-admin-api/dynamic-offer-promo-code-redemption/processpromocoderedemptions","metadata":{"seo":{"title":"Process promo code redemptions","description":"Redeem promo codes that are configured from the Zephr console. Responds with a list of redemption results for each promo code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processPromoCodeRedemptions","name":"Process promo code redemptions","isWebhook":false,"pointer":"/paths/~1zephr~1integration~1promo-codes~1v1~1redemptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Process promo code redemptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Redeem promo codes that are configured from the Zephr console.\nResponds with a list of redemption results for each promo code.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_59"}},"schemaId":"schema_59","pointer":"/paths/~1zephr~1integration~1promo-codes~1v1~1redemptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/zephr/integration/promo-codes/v1/redemptions","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_59"}},"responseCodes":["200"],"pointer":"/zephr/integration/promo-codes/v1/redemptions","href":"dynamic-offer-promo-code-redemption/processpromocoderedemptions","openApiOperationId":"processPromoCodeRedemptions","summary":"Process promo code redemptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_59","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_59"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_60"}},"schemaId":"schema_60","headers":{}}],"pointer":"/paths/~1zephr~1integration~1promo-codes~1v1~1redemptions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_60","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_60"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-offer-promo-code-redemption/processpromocoderedemptions"}],"panels":[]}]},"httpPath":"/zephr/integration/promo-codes/v1/redemptions"}],"content":{"contentType":"group","meta":{"name":"Dynamic Offer Promo code redemption"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dynamic Offer Promo code redemption","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/zephr/integration/promo-codes/v1/redemptions","summary":"Process promo code redemptions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dynamic-offer-promo-code-redemption/processpromocoderedemptions","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscription","link":"/zephr-api-reference/zephr-admin-api/subscription","routeSlug":"/zephr-api-reference/zephr-admin-api/subscription","items":[{"label":"Cancel Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/subscription/cancelsubscriptionlegacy","routeSlug":"/zephr-api-reference/zephr-admin-api/subscription/cancelsubscriptionlegacy","metadata":{"seo":{"title":"Cancel Subscription","description":"Cancels a subscription using the legacy method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelSubscriptionLegacy","name":"Cancel Subscription","isWebhook":false,"pointer":"/paths/~1blaize~1payment~1braintree~1subscriptions~1{externalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels a subscription using the legacy method."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_0","description":"External subscription identifier","required":true}],"pointer":"/paths/~1blaize~1payment~1braintree~1subscriptions~1{externalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/blaize/payment/braintree/subscriptions/{externalId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"responseCodes":["200","403","409","500"],"pointer":"/blaize/payment/braintree/subscriptions/{externalId}","href":"subscription/cancelsubscriptionlegacy","openApiOperationId":"cancelSubscriptionLegacy","summary":"Cancel Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription cancellation processed successfully.","headers":{}},{"code":"403","description":"Forbidden - The request was not authorized.","headers":{}},{"code":"409","description":"Conflict - There was a conflict processing the request.","headers":{}},{"code":"500","description":"Internal Server Error - An error occurred while cancelling the subscription.","headers":{}}],"pointer":"/paths/~1blaize~1payment~1braintree~1subscriptions~1{externalId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/cancelsubscriptionlegacy"}],"panels":[]}]},"httpPath":"/blaize/payment/braintree/subscriptions/{externalId}"},{"label":"Update Braintree Subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zephr-api-reference/zephr-admin-api/subscription/orchestrateupdatebraintreesubscription","routeSlug":"/zephr-api-reference/zephr-admin-api/subscription/orchestrateupdatebraintreesubscription","metadata":{"seo":{"title":"Update Braintree Subscription","description":"Updates a Braintree subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orchestrateUpdateBraintreeSubscription","name":"Update Braintree Subscription","isWebhook":false,"pointer":"/paths/~1blaize~1payment~1braintree~1subscriptions~1{externalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Braintree Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a Braintree subscription."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ZephrHmacHttp","scopes":[],"type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalId","in":"path","schemaId":"schema_0","description":"External subscription identifier","required":true}],"pointer":"/paths/~1blaize~1payment~1braintree~1subscriptions~1{externalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_8"}},"schemaId":"schema_8","pointer":"/paths/~1blaize~1payment~1braintree~1subscriptions~1{externalId}/patch/requestBody","description":"Update Subscription Request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/blaize/payment/braintree/subscriptions/{externalId}","servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"parameters":{"path":[{"name":"externalId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_8"}},"responseCodes":["204","401","500"],"pointer":"/blaize/payment/braintree/subscriptions/{externalId}","href":"subscription/orchestrateupdatebraintreesubscription","openApiOperationId":"orchestrateUpdateBraintreeSubscription","summary":"Update Braintree Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo"}}}],"schemaId":"schema_8","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_8"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content - The subscription update was successful.","headers":{}},{"code":"401","description":"Unauthorized - Authentication is required.","headers":{}},{"code":"500","description":"Internal Server Error - An error occurred while updating the subscription.","headers":{}}],"pointer":"/paths/~1blaize~1payment~1braintree~1subscriptions~1{externalId}/patch/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/orchestrateupdatebraintreesubscription"}],"panels":[]}]},"httpPath":"/blaize/payment/braintree/subscriptions/{externalId}"}],"content":{"contentType":"group","meta":{"name":"Subscription"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/blaize/payment/braintree/subscriptions/{externalId}","summary":"Cancel Subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscription/cancelsubscriptionlegacy","deprecated":false},{"title":"/blaize/payment/braintree/subscriptions/{externalId}","summary":"Update Braintree Subscription","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/subscription/orchestrateupdatebraintreesubscription","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/blacklisted-email-domains-request":{"id":"components/schemas/blacklisted-email-domains-request","kind":"json-schema","title":"blacklisted-email-domains-request","data":{"type":"array","description":"List of email domains to blacklist.","items":{"type":"string","example":"spam.com"},"uniqueItems":true,"minItems":0}},"components/schemas/blacklisted-email-domains-response":{"id":"components/schemas/blacklisted-email-domains-response","kind":"json-schema","title":"blacklisted-email-domains-response","data":{"type":"object","properties":{"message":{"type":"string","example":"Blacklisted email domains updated successfully"}}}},"components/schemas/account-user":{"id":"components/schemas/account-user","kind":"json-schema","title":"account-user","data":{"type":"object","properties":{"user_id":{"type":"string","example":"54de866e-dc98-48d6-a2ea-4736a430f273"},"account_id":{"type":"string","example":"e196ad75-a6d0-471b-90b3-de3843dd7860"},"user_type":{"type":"string","example":"user"},"user_email":{"type":"string","example":"user@example.com"},"user_name":{"type":"string","example":"username123"}}}},"components/schemas/admin-user-response":{"id":"components/schemas/admin-user-response","kind":"json-schema","title":"admin-user-response","data":{"type":"object","properties":{"user_id":{"type":"string","example":"b859f5dd-8184-4d01-8bf9-e3e771f68a62"},"message":{"type":"string","example":"Admin user created successfully"},"uri":{"type":"string","example":"http://company.com/v3/admin/users/b859f5dd-8184-4d01-8bf9-e3e771f68a62"}}}},"components/schemas/admin-user-login-response":{"id":"components/schemas/admin-user-login-response","kind":"json-schema","title":"admin-user-login-response","data":{"type":"object","properties":{"cookie":{"type":"string","example":"blaize_admin_session=..."},"message":{"type":"string","example":"Login successful"}}}},"components/schemas/logout-response":{"id":"components/schemas/logout-response","kind":"json-schema","title":"logout-response","data":{"type":"object","properties":{"message":{"type":"string","example":"Session deleted"}}}},"components/schemas/access-key":{"id":"components/schemas/access-key","kind":"json-schema","title":"access-key","data":{"type":"object","properties":{"access_key":{"type":"string","example":"access key..."}}}},"components/schemas/keypair-response":{"id":"components/schemas/keypair-response","kind":"json-schema","title":"keypair-response","data":{"type":"object","properties":{"secret_key":{"type":"string","example":"secret key..."},"message":{"type":"string","example":"Keypair created: you will not be able to recover the secret, so take note of it"}}}},"components/schemas/issue-keypair-response":{"id":"components/schemas/issue-keypair-response","kind":"json-schema","title":"issue-keypair-response","data":{"type":"object","properties":{"secret_key":{"type":"string","example":"secret key..."},"message":{"type":"string","example":"Keypair created: you will not be able to recover the secret, so take note of it"},"access_key":{"type":"string","example":"access key..."}}}},"components/schemas/get-access-key-response":{"id":"components/schemas/get-access-key-response","kind":"json-schema","title":"get-access-key-response","data":{"type":"array","items":{"$ref":"#/components/schemas/access-key"}}},"components/schemas/revoke-keypair-response":{"id":"components/schemas/revoke-keypair-response","kind":"json-schema","title":"revoke-keypair-response","data":{"type":"object","properties":{"message":{"type":"string","example":"Keypair revoked"}}}},"components/schemas/admin-role":{"id":"components/schemas/admin-role","kind":"json-schema","title":"admin-role","data":{"type":"object","properties":{"email":{"type":"string","example":"admin@company.com"},"role":{"type":"string","example":"role..."}}}},"components/schemas/admin-roles":{"id":"components/schemas/admin-roles","kind":"json-schema","title":"admin-roles","data":{"type":"array","items":{"$ref":"#/components/schemas/admin-role"}}},"components/schemas/admin-role-creation-response":{"id":"components/schemas/admin-role-creation-response","kind":"json-schema","title":"admin-role-creation-response","data":{"type":"object","properties":{"message":{"type":"string","example":"Admin role created successfully"}}}},"components/schemas/list-admin-role-response":{"id":"components/schemas/list-admin-role-response","kind":"json-schema","title":"list-admin-role-response","data":{"type":"object","properties":{"email":{"type":"string","example":"admin@company.com"},"role":{"type":"string","example":"role..."},"role_id":{"type":"string"}}}},"components/schemas/list-admin-roles-response":{"id":"components/schemas/list-admin-roles-response","kind":"json-schema","title":"list-admin-roles-response","data":{"type":"array","items":{"$ref":"#/components/schemas/list-admin-role-response"}}},"components/schemas/admin-role-update-response":{"id":"components/schemas/admin-role-update-response","kind":"json-schema","title":"admin-role-update-response","data":{"type":"object","properties":{"message":{"type":"string","example":"Admin role updated successfully"}}}},"components/schemas/admin-role-deleted-response":{"id":"components/schemas/admin-role-deleted-response","kind":"json-schema","title":"admin-role-deleted-response","data":{"type":"object","properties":{"message":{"type":"string","example":"Admin role deleted successfully"}}}},"components/schemas/user_identifier":{"id":"components/schemas/user_identifier","kind":"json-schema","title":"user_identifier","data":{"type":"object","properties":{"user_id":{"type":"string","example":"123456789ABCD"}}}},"components/schemas/entitlement":{"id":"components/schemas/entitlement","kind":"json-schema","title":"entitlement","data":{"type":"object","properties":{"label":{"type":"string","example":"Test entitlement"},"description":{"type":"string","example":"This is an entitlement"},"auto_assign":{"type":"string","example":"none"}}}},"components/schemas/includes":{"id":"components/schemas/includes","kind":"json-schema","title":"includes","data":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"string"},"example":[]},"meters":{"type":"array","items":{"type":"string"},"example":[]},"credits":{"type":"array","items":{"type":"string"},"example":[]},"bundles":{"type":"array","items":{"type":"string"},"example":[]}}}},"components/schemas/bundle":{"id":"components/schemas/bundle","kind":"json-schema","title":"bundle","data":{"type":"object","properties":{"tenantId":{"type":"string","example":"company"},"subTenantId":{"type":"string","example":"company|demo"},"type":{"type":"string","example":"bundle"},"id":{"type":"string","example":"1163991e-d671-4695-9ac0-b3d63fecfc20"},"label":{"type":"string","example":"Test bundle"},"description":{"type":"string","description":"Returned if not null","example":"This is a bundle"},"includes":{"$ref":"#/components/schemas/includes"},"auto_assign":{"enum":["none","all","anonymous","authenticated"],"example":"none"}}}},"components/schemas/bundles":{"id":"components/schemas/bundles","kind":"json-schema","title":"bundles","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/bundle"}}}}},"components/schemas/cache_configurations_objects":{"id":"components/schemas/cache_configurations_objects","kind":"json-schema","title":"cache_configurations_objects","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/cache_configurations_object"}}}}},"components/schemas/cache_configurations_object":{"id":"components/schemas/cache_configurations_object","kind":"json-schema","title":"cache_configurations_object","data":{"type":"object","properties":{"label":{"type":"string","example":"Test"},"conditions":{"$ref":"#/components/schemas/conditions"},"cache":{"$ref":"#/components/schemas/cache"},"redirect":{"$ref":"#/components/schemas/redirect"}}}},"components/schemas/conditions":{"id":"components/schemas/conditions","kind":"json-schema","title":"conditions","data":{"type":"object","properties":{"url_pattern":{"type":"string","example":"^/forum"},"header_patterns":{"$ref":"#/components/schemas/header_patterns"}}}},"components/schemas/header_patterns":{"id":"components/schemas/header_patterns","kind":"json-schema","title":"header_patterns","data":{"type":"object","properties":{"Content-Type":{"type":"string","example":"^text/html"}}}},"components/schemas/cache":{"id":"components/schemas/cache","kind":"json-schema","title":"cache","data":{"type":"object","properties":{"origin":{"type":"boolean"},"decision_points":{"type":"boolean"}}}},"components/schemas/redirect":{"id":"components/schemas/redirect","kind":"json-schema","title":"redirect","data":{"type":"object","properties":{"on":{"type":"boolean"},"target":{"type":"string","example":"/some/path"},"status":{"type":"integer","example":301}}}},"components/schemas/companies":{"id":"components/schemas/companies","kind":"json-schema","title":"companies","data":{"type":"array","items":{"$ref":"#/components/schemas/company"}}},"components/schemas/company":{"id":"components/schemas/company","kind":"json-schema","title":"company","data":{"type":"object","properties":{"name":{"type":"string","example":"Company name"},"description":{"type":"string","example":"Company description"},"website":{"type":"string","example":"company.com"},"contact":{"type":"string","example":"Company contact"},"account_manager":{"type":"string","example":"Company account manager"}}}},"components/schemas/companyv4":{"id":"components/schemas/companyv4","kind":"json-schema","title":"companyv4","data":{"type":"object","properties":{"company_id":{"type":"string","example":"1f6841a8-7f3b-4505-856e-4549be433545","description":"Company identifier"},"name":{"type":"string","description":"Company name","example":"My Company"},"description":{"type":"string","description":"Company description","example":"This is an example company"},"website":{"type":"string","description":"Company website","example":"https://company.com"},"contact":{"type":"string","description":"The company's contact information","example":"email@company.com"},"account_manager":{"type":"string","description":"Company account manager","example":"Joe Blow"},"tenantId":{"type":"string","description":"Tenant identifier","example":"my-tenant"},"subTenantId":{"type":"string","description":"Sub-tenant identifier (it will match the tenantId if the company is not part of a super tenant)","example":"my-tenant"}}}},"components/schemas/configuration":{"id":"components/schemas/configuration","kind":"json-schema","title":"configuration","data":{"type":"object","properties":{"db.tables.extendedProfiles":{"type":"string","example":"value"},"db.tables.grants":{"type":"string","example":"value"},"db.tables.forms":{"type":"string","example":"value"},"db.tables.features":{"type":"string","example":"value"},"db.tables.requestRules":{"type":"string","example":"value"},"db.tables.entitlements":{"type":"string","example":"value"},"db.tables.formFields":{"type":"string","example":"value"},"db.tables.companies":{"type":"string","example":"value"},"db.tables.accounts":{"type":"string","example":"value"},"db.tables.userSchemaFields":{"type":"string","example":"value"},"db.tables.users":{"type":"string","example":"value"},"db.tables.userAttributes":{"type":"string","example":"value"},"db.tables.accountUsers":{"type":"string","example":"value"},"db.tables.staticItems":{"type":"string","example":"value"},"db.tables.webhooks":{"type":"string","example":"value"},"db.tables.adminUserTenantRoles":{"type":"string","example":"value"},"db.tables.adminUsers":{"type":"string","example":"value"},"db.tables.adminKeyPairs":{"type":"string","example":"value"},"oauth.google.apis.host":{"type":"string","example":"value"},"oauth.linkedin.clientSecret":{"type":"string","example":"value"},"oauth.linkedin.apis.host":{"type":"string","example":"value"},"oauth.google.clientSecret":{"type":"string","example":"value"},"oauth.google.callbackUri":{"type":"string","example":"value"},"oauth.linkedin.clientId":{"type":"string","example":"value"},"oauth.linkedin.callbackUri":{"type":"string","example":"value"},"oauth.google.clientId":{"type":"string","example":"value"},"oauth.facebook.callbackUri":{"type":"string","example":"value"},"oauth.facebook.clientSecret":{"type":"string","example":"value"},"oauth.facebook.apis.host":{"type":"string","example":"value"},"oauth.facebook.clientId":{"type":"string","example":"value"},"cdn.origin":{"type":"string","example":"value"},"redis.port":{"type":"string","example":"value"},"elasticsearch.url":{"type":"string","example":"value"},"aws.region":{"type":"string","example":"value"},"redis.host":{"type":"string","example":"value"},"email.from":{"type":"string","example":"value"},"authentication.password.requireEmailVerfication":{"type":"string","example":"value"}}}},"components/schemas/credits":{"id":"components/schemas/credits","kind":"json-schema","title":"credits","data":{"type":"array","items":{"$ref":"#/components/schemas/credit"}}},"components/schemas/credit":{"id":"components/schemas/credit","kind":"json-schema","title":"credit","data":{"type":"object","properties":{"label":{"type":"string","example":"Test credit"},"description":{"type":"string","example":"This is an credit"},"delivers":{"type":"array","items":{}},"unit":{"type":"string","example":"views"},"quantity":{"type":"number","example":5},"auto_assign":{"type":"string","example":"none"}}}},"components/schemas/access_model_credit":{"id":"components/schemas/access_model_credit","kind":"json-schema","title":"access_model_credit","data":{"type":"object","properties":{"remainingCredits":{"type":"integer","example":5},"contentIds":{"type":"array","items":{"type":"string"},"example":["123456789ABCD"]},"contentIdTransform":{"type":"string","enum":["NONE","PREPEND_RANDOM","STRIP_PARAMS"]}}}},"components/schemas/headers":{"id":"components/schemas/headers","kind":"json-schema","title":"headers","data":{"type":"object","properties":{"Location":{"type":"string","example":"/login.html"}}}},"components/schemas/access-decision-response":{"id":"components/schemas/access-decision-response","kind":"json-schema","title":"access-decision-response","data":{"type":"object","properties":{"status":{"type":"string","example":"301"},"body":{"type":"string","example":"Redirecting to login page..."},"headers":{"$ref":"#/components/schemas/headers"}}}},"components/schemas/email-templates":{"id":"components/schemas/email-templates","kind":"json-schema","title":"email-templates","data":{"type":"array","items":{"$ref":"#/components/schemas/email-template"}}},"components/schemas/email-template":{"id":"components/schemas/email-template","kind":"json-schema","title":"email-template","data":{"type":"object","properties":{"templateType":{"type":"string","example":"template type","description":"The template type. Supported types: User Password Reset, User Email Update, User Email Verification, User Complete Registration, User Passwordless Authentication, User Oversubscription Notification, User 2FA Authentication, User 2FA Password Reset, User Email Update Interstitial, Pages User Email Update, Pages User Password Reset, Admin User 2FA Authentication, Admin User Role, Admin User Password Reset"},"slug":{"type":"string","example":"email template slug","description":"It can be one of the default email template slugs provided or a custom one. Default email template slugs provided: password-reset-email, user-update-email, verify-email-address, complete-user-registration, passwordless-authentication-email, user-oversubscription-notification, two-factor-authentication-email, password-reset-email-2fa, user-interstitial-update-email, pages-user-email-update-otp-email-template, pages-password-reset-email, admin-user-2fa-email-template, v4-admin-user-role-assigned-email, v4-admin-user-password-reset-email."},"label":{"type":"string","example":"Name of the email template","description":"Name of the email template"},"subject":{"type":"string","example":"Email subject","description":"The subject on the email"},"content":{"type":"string","example":"Email content","description":"The content of the email"},"default":{"type":"boolean","description":"Whether is one of the default email templates"}}}},"components/schemas/entitlements":{"id":"components/schemas/entitlements","kind":"json-schema","title":"entitlements","data":{"type":"array","items":{"$ref":"#/components/schemas/entitlement"}}},"components/schemas/feature_rules_response":{"id":"components/schemas/feature_rules_response","kind":"json-schema","title":"feature_rules_response","data":{"type":"array","items":{"$ref":"#/components/schemas/feature_rule_response"}}},"components/schemas/feature_rule_response":{"id":"components/schemas/feature_rule_response","kind":"json-schema","title":"feature_rule_response","data":{"type":"object","properties":{"id":{"type":"string","example":"featureRuleId"},"version":{"type":"number","example":1},"tags":{"type":"array","items":{}},"label":{"type":"string","example":"Test feature"},"description":{"type":"string","example":"Test feature"},"last_updated":{"type":"string","example":"2011-11-11T11:11:11.000"},"request_type":{"type":"string","enum":["html","json","graphql"],"example":"html"},"target_name":{"type":"string","example":"article"},"match_operation":{"type":"string","enum":["equals","contains"],"example":"equals"},"target_value":{"type":"string","example":"home_bottom"},"css_selector":{"type":"string","example":".trial-download-single.trial"}}}},"components/schemas/feature_rule_version_response":{"id":"components/schemas/feature_rule_version_response","kind":"json-schema","title":"feature_rule_version_response","data":{"type":"object","properties":{"id":{"type":"string","example":"featureRuleId"},"version":{"type":"number","example":1},"tags":{"type":"array","items":{}},"label":{"type":"string","example":"Test feature"},"description":{"type":"string","example":"Test feature"},"requirements_script":{"type":"string","example":"return []"},"action_script":{"type":"string","example":"return \"this is a test\""},"script_type":{"type":"string","example":"javascript"},"graph_state":{"type":"string","example":"{\"property1\": \"value1\"}"},"editing_mode":{"type":"string","example":"manual"},"last_updated":{"type":"string","example":"2011-11-11T11:11:11.000"}}}},"components/schemas/feature_rule_deletion_response":{"id":"components/schemas/feature_rule_deletion_response","kind":"json-schema","title":"feature_rule_deletion_response","data":{"type":"object","properties":{"message":{"type":"string","example":"featureRuleId deleted successfully"}}}},"components/schemas/feature_rule_creation_response":{"id":"components/schemas/feature_rule_creation_response","kind":"json-schema","title":"feature_rule_creation_response","data":{"type":"object","properties":{"message":{"type":"string","example":"Feature Rule created successfully"}}}},"components/schemas/feature_rule_version_tags_update_response":{"id":"components/schemas/feature_rule_version_tags_update_response","kind":"json-schema","title":"feature_rule_version_tags_update_response","data":{"type":"object","properties":{"message":{"type":"string","example":"featureRuleId tag/s saved successfully"},"uri":{"type":"string","example":"http://host/v3/feature-rules/featureRuleId/versions/versionId/tags"}}}},"components/schemas/forms":{"id":"components/schemas/forms","kind":"json-schema","title":"forms","data":{"type":"array","items":{"$ref":"#/components/schemas/form"}}},"components/schemas/form":{"id":"components/schemas/form","kind":"json-schema","title":"form","data":{"type":"object","properties":{"title":{"type":"string","example":"Test"},"internal-description":{"type":"string","example":"This form is for testing"},"public-description":{"type":"string","example":"Please provide some info"},"registration":{"type":"boolean","example":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/field"}}}}},"components/schemas/field":{"id":"components/schemas/field","kind":"json-schema","title":"field","data":{"type":"object","properties":{"slug":{"type":"string","example":"first-name"},"placeholder":{"type":"string","example":"first-name"},"required":{"type":"boolean","example":true},"order":{"type":"number","example":1}}}},"components/schemas/gifts":{"id":"components/schemas/gifts","kind":"json-schema","title":"gifts","data":{"type":"array","items":{"$ref":"#/components/schemas/gift"}}},"components/schemas/gift":{"id":"components/schemas/gift","kind":"json-schema","title":"gift","data":{"type":"object","properties":{"id":{"type":"string","example":"58c3852bb23f3467","description":"Gift Id (passed as ?gift parameter in claim link)"},"created":{"type":"string","example":"2018-04-27T09:15:28Z","description":"UTC timestamp when gift was created"},"claimed":{"type":"string","description":"UTC timestamp when gift was claimed"},"uri":{"type":"string","example":"/news/local/story","description":"1823.html (string) - Path portion of URL gift will allow access to"},"cross_device_session":{"type":"string","description":"ID of cross-device session of claiming user (if claimed)"}}}},"components/schemas/grants-response":{"id":"components/schemas/grants-response","kind":"json-schema","title":"grants-response","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/grant-response"}}}}},"components/schemas/active-grants-response":{"id":"components/schemas/active-grants-response","kind":"json-schema","title":"active-grants-response","data":{"type":"array","items":{"$ref":"#/components/schemas/grant-response"}}},"components/schemas/grant-response":{"id":"components/schemas/grant-response","kind":"json-schema","title":"grant-response","data":{"type":"object","properties":{"grantId":{"type":"string","example":"e196ad75-a6d0-471b-90b3-de3843dd7860"},"user_id":{"type":"string","example":"e1812285-2f21-441e-8be4-b08835cd4b2c"},"account_id":{"type":"string","example":"14515649-565f-4b1c-8346-eb98301c1d6b"},"expiry_state":{"type":"string","enum":["pending","active","expired"]},"entitlement_type":{"type":"string","enum":["bundle","entitlement","meter","credits"],"description":"An enum describing the type of the entitlement."},"entitlement_id":{"type":"string","example":"b74df5c4-fded-492c-ad90-07646bded5db"},"startTime":{"type":"string","example":"2022-06-01 00:00:00"},"endTime":{"type":"string","example":"2022-12-31 23:59:59"},"product_id":{"type":"string","example":"86abb44a-e6f2-4f9b-ac26-46ae0a13ed31"},"createdAt":{"type":"string","example":"2022-05-31 23:59:59"}}}},"components/schemas/grant":{"id":"components/schemas/grant","kind":"json-schema","title":"grant","data":{"type":"object","required":["entitlement_type","entitlement_id","product_id"],"properties":{"grantId":{"type":"string","example":"e196ad75-a6d0-471b-90b3-de3843dd7860"},"user_id":{"type":"string","example":"e1812285-2f21-441e-8be4-b08835cd4b2c"},"account_id":{"type":"string","example":"14515649-565f-4b1c-8346-eb98301c1d6b"},"expiry_state":{"type":"string","enum":["pending","active","expired"]},"entitlement_type":{"type":"string","enum":["bundle","entitlement","meter","credits"],"description":"An enum describing the type of the entitlement."},"entitlement_id":{"type":"string","example":"b74df5c4-fded-492c-ad90-07646bded5db"},"startTime":{"type":"string","example":"2022-06-01 00:00:00"},"endTime":{"type":"string","example":"2022-12-31 23:59:59"},"product_id":{"type":"string","example":"86abb44a-e6f2-4f9b-ac26-46ae0a13ed31"},"createdAt":{"type":"string","example":"2022-05-31 23:59:59"}}}},"components/schemas/grant-creation-request":{"id":"components/schemas/grant-creation-request","kind":"json-schema","title":"grant-creation-request","data":{"type":"object","properties":{"grantId":{"type":"string","example":"5700aae1-461d-47d7-9a4c-d84412da7053"},"entitlement_type":{"type":"string","enum":["bundle","entitlement","meter","credits"],"description":"An enum describing the type of the entitlement."},"entitlement_id":{"type":"string","example":"cae85210-c942-490f-a24a-614033c51e49"},"user_id":{"type":"string","example":"16b26d63-4ee9-4955-9d8b-f6625300d040"},"expiry_state":{"type":"string","enum":["active","pending","expired"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible states of the grant. When the grant is meant to start in the future, it has the state of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"startTime":{"type":"string","example":"2024-02-01 00:00:00","description":"Date when grant starts."},"endTime":{"type":"string","example":"2024-03-01 23:59:59","description":"Date when grant expires. When not present in the response, it means the grant is indefinite."},"product_id":{"type":"string","example":"gold"},"created_at":{"type":"string","example":"2024-03-01 00:00:00","description":"Date when the grant was created in Zephr."}}}},"components/schemas/access_model":{"id":"components/schemas/access_model","kind":"json-schema","title":"access_model","data":{"type":"object","properties":{"meters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/access_model_meter"}},"credits":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/access_model_credit"}},"delivered_entitlements":{"type":"array","items":{"$ref":"#/components/schemas/delivered_entitlement"}},"granted_bundles":{"type":"array","items":{"type":"string"},"example":["e10a5ff3-fc63-47fb-af04-75c2ec3fdf1c"]},"jwt_bundles":{"type":"array","items":{"items":{"type":"string"}},"example":[]},"user_state":{"type":"string","example":"registered"}}}},"components/schemas/delivered_entitlement":{"id":"components/schemas/delivered_entitlement","kind":"json-schema","title":"delivered_entitlement","data":{"type":"object","properties":{"id":{"type":"string","example":"0123456789ABCD"},"direct":{"type":"boolean","example":true},"meteredBy":{"type":"array","items":{"type":"string"},"example":[]},"creditedBy":{"type":"array","items":{"type":"string"},"example":[]}}}},"components/schemas/meters":{"id":"components/schemas/meters","kind":"json-schema","title":"meters","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/meter"}}}}},"components/schemas/meter":{"id":"components/schemas/meter","kind":"json-schema","title":"meter","data":{"type":"object","properties":{"label":{"type":"string","example":"Test meter"},"description":{"type":"string","example":"This is a meter"},"unit":{"type":"string","example":"views"},"limit":{"type":"number","example":5},"cycle":{"type":"string","example":"calendar"},"period":{"type":"string","example":"monthly"},"timezone":{"type":"string","example":"+0:00"},"auto_assign":{"type":"string","example":"none"}}}},"components/schemas/access_model_meter":{"id":"components/schemas/access_model_meter","kind":"json-schema","title":"access_model_meter","data":{"type":"object","properties":{"refreshTime":{"type":"string","example":"2024-06-01 00:00:00"},"meterSize":{"type":"integer","example":5},"remainingCredits":{"type":"integer","example":5},"contentIds":{"type":"array","items":{"type":"string"},"example":["123456789ABCD"]},"contentIdTransform":{"type":"string","enum":["NONE","PREPEND_RANDOM","STRIP_PARAMS"]}}}},"components/schemas/products":{"id":"components/schemas/products","kind":"json-schema","title":"products","data":{"type":"array","items":{"$ref":"#/components/schemas/product"}}},"components/schemas/product-request":{"id":"components/schemas/product-request","kind":"json-schema","title":"product-request","data":{"type":"object","required":["label","entitlement","mapping"],"properties":{"label":{"type":"string","example":"Gold Subscription","description":"The product label. This is the human-readable name of the product."},"description":{"type":"string","example":"The most premium subscription.","description":"The product description. This is a human-readable description of the product."},"entitlement":{"$ref":"#/components/schemas/product.entitlement"},"mapping":{"$ref":"#/components/schemas/product.mapping"},"sharingLimit":{"type":"number","example":5,"description":"The number of other users that the purchaser of this product can share the product with."}}}},"components/schemas/product":{"id":"components/schemas/product","kind":"json-schema","title":"product","data":{"type":"object","properties":{"tenantId":{"type":"string","example":"company"},"subTenantId":{"type":"string","example":"company|demo"},"id":{"type":"string","example":"gold","description":"The product ID/slug. This is the unique identifier for the product within the tenant."},"label":{"type":"string","example":"Gold Subscription","description":"The product label. This is the human-readable name of the product."},"description":{"type":"string","example":"The most premium subscription.","description":"The product description. This is a human-readable description of the product."},"entitlement":{"$ref":"#/components/schemas/product.entitlement"},"mapping":{"$ref":"#/components/schemas/product.mapping"},"sharingLimit":{"type":"number","example":5,"description":"The number of other users that the purchaser of this product can share the product with."}}}},"components/schemas/product.entitlement":{"id":"components/schemas/product.entitlement","kind":"json-schema","title":"product.entitlement","data":{"type":"object","properties":{"id":{"type":"string","example":"gold-bundle","description":"Entitlement ID/slug."},"type":{"type":"string","example":"bundle","description":"Entitlement type (always \"bundle\")."},"entitlementTenant":{"type":"string","example":"company","description":"Entitlement tenant ID."}}}},"components/schemas/product.mapping":{"id":"components/schemas/product.mapping","kind":"json-schema","title":"product.mapping","data":{"type":"object","properties":{"braintree_recurring":{"type":"object","properties":{"plan_id":{"type":"string","example":"gold","description":"The Braintree plan ID. This is the unique identifier for the plan within the Braintree account."},"archived":{"type":"boolean","example":true,"description":"Whether the product is archived. If true, the product will not be available for purchase."}}},"braintree_one_off":{"type":"object","properties":{"price_points":{"type":"array","items":{"$ref":"#/components/schemas/product.mapping.price_point"}}}},"stripe_recurring":{"type":"object","properties":{"stripe_plan_id":{"type":"string","example":"gold","description":"The Stripe plan ID. This is the unique identifier for the plan within the Stripe account."}}},"stripe_one_off":{"type":"object","properties":{"price_points":{"type":"array","items":{"$ref":"#/components/schemas/product.mapping.price_point"}}}},"rate_plans":{"type":"array","items":{"$ref":"#/components/schemas/product.mapping.rate_plan"}},"jwt":{"$ref":"#/components/schemas/product.mapping.jwt"}},"example":{"braintree_one_off":{"price_points":[{"id":"ten","label":"Ten Dollars","price":10}]}}}},"components/schemas/product.mapping.price_point":{"id":"components/schemas/product.mapping.price_point","kind":"json-schema","title":"product.mapping.price_point","data":{"type":"object","required":["id","label","price"],"properties":{"id":{"type":"string","example":"ten","description":"The unique identifier for the price point within the product."},"label":{"type":"string","example":"Ten Dollars","description":"The human-readable name of the price point."},"price":{"type":"number","example":10,"description":"The price of the product in the currency of the payment provider account."},"archived":{"type":"boolean","example":true,"description":"Whether the price point is archived. If true, the price point will not be available for purchase."}}}},"components/schemas/product.mapping.rate_plan":{"id":"components/schemas/product.mapping.rate_plan","kind":"json-schema","title":"product.mapping.rate_plan","data":{"type":"object","required":["payment_provider","rate_plan_id","environment"],"properties":{"payment_provider":{"type":"string","description":"The payment provider for which the rate plan is configured."},"rate_plan_id":{"type":"string","description":"The unique identifier for the rate plan within the payment provider account."},"archived":{"type":"boolean","description":"Whether the rate plan is archived. If true, the rate plan will not be available for purchase."},"archive_label":{"type":"string","description":"The human-readable name of the rate plan."},"environment":{"type":"string","example":"LIVE","description":"The environment for which the rate plan is configured."}}}},"components/schemas/product.mapping.jwt":{"id":"components/schemas/product.mapping.jwt","kind":"json-schema","title":"product.mapping.jwt","data":{"type":"object","properties":{"privateClaimValue":{"type":"string"}}}},"components/schemas/request_rules_container_object":{"id":"components/schemas/request_rules_container_object","kind":"json-schema","title":"request_rules_container_object","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/request_rules_object"}}}}},"components/schemas/request_rules_object":{"id":"components/schemas/request_rules_object","kind":"json-schema","title":"request_rules_object","data":{"type":"object","properties":{"label":{"type":"string","example":"Test"},"description":{"type":"string","example":"This rule tests for authenticated users"},"priority":{"type":"integer","example":1},"version":{"type":"number","example":1},"last_updated":{"type":"string","example":"2011-11-11T11:11:11.000"},"conditions":{"$ref":"#/components/schemas/request_rules_conditions"},"lastUpdatedAt":{"type":"string","example":"2022-06-01 00:00:00"},"requirements_script":{"type":"string","example":"return []"},"action_script":{"type":"string","example":"return \"this is a test\""},"script_type":{"type":"string","example":"javascript"},"graph_state":{"type":"string","example":"{\"property1\": \"value1\"}"},"editing_mode":{"type":"string","example":"manual"}}}},"components/schemas/request_rules_conditions":{"id":"components/schemas/request_rules_conditions","kind":"json-schema","title":"request_rules_conditions","data":{"type":"object","properties":{"url_pattern":{"type":"string","example":"^/forum"},"method":{"type":"string","example":"GET"}}}},"components/schemas/session":{"id":"components/schemas/session","kind":"json-schema","title":"session","data":{"type":"object","properties":{"tenantId":{"type":"string","example":"company"},"subTenantId":{"type":"string","example":"company|demo"},"supplied":{"type":"boolean","example":false},"expiryDate":{"type":"string","example":"2025-02-08 14:29 PM UTC"},"startDate":{"type":"string","example":"2024-02-08 14:29 PM UTC"},"authenticated":{"type":"boolean","example":true},"state":{"type":"string","enum":["anonymous","recognised","partially_registered","authenticated"],"example":"authenticated"},"device":{"type":"string","example":"pc"},"browser":{"type":"string","example":"Chrome"},"os":{"type":"string","example":"Mac OSX"},"city":{"type":"string","example":"London"},"geoState":{"type":"string","example":"London"},"deviceName":{"type":"string","example":"Apple Macintosh"},"country":{"type":"string","description":"ISO-3166-2 country code","example":"GB"},"session_id":{"type":"string","example":"26a73b7a-f7d0-48d8-85dd-a04b07313895"},"user_id":{"type":"string","example":"UU0123456789ABCD"}}}},"components/schemas/session-lookup":{"id":"components/schemas/session-lookup","kind":"json-schema","title":"session-lookup","data":{"type":"object","properties":{"tenantId":{"type":"string","example":"company"},"subTenantId":{"type":"string","example":"company|demo"},"authenticated":{"type":"boolean","example":true},"v":{"type":"integer","description":"version","example":0},"session_variables":{"$ref":"#/components/schemas/session_variables"},"user_id":{"type":"string","example":"UU0123456789ABCD"},"sessions":{"$ref":"#/components/schemas/sessions"},"access_model":{"$ref":"#/components/schemas/access_model"},"last_updated":{"type":"integer","description":"A timestamp indicating the last update of the session, measured in milliseconds since the epoch.","example":1707230240685},"test_groups":{"type":"object","additionalProperties":{"type":"string"}},"second_party_data":{"type":"object","additionalProperties":{"type":"string"}}}}},"components/schemas/session_variables":{"id":"components/schemas/session_variables","kind":"json-schema","title":"session_variables","data":{"type":"object","properties":{}}},"components/schemas/static_items":{"id":"components/schemas/static_items","kind":"json-schema","title":"static_items","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/static_item"}}}}},"components/schemas/static_item":{"id":"components/schemas/static_item","kind":"json-schema","title":"static_item","data":{"type":"object","properties":{"id":{"type":"string","example":"123456789ABCD"}}}},"components/schemas/static_single_item":{"id":"components/schemas/static_single_item","kind":"json-schema","title":"static_single_item","data":{"type":"object","properties":{"id":{"type":"string","example":"123456789ABCD"},"item":{"type":"string","example":{}}}}},"components/schemas/oauth2-token-refresh-response":{"id":"components/schemas/oauth2-token-refresh-response","kind":"json-schema","title":"oauth2-token-refresh-response","data":{"type":"object","properties":{"scope":{"type":"string","example":"user.account:read user.profile:read user.profile:update","description":"The scope of the access request. Supported scopes: user.account:read, user.profile:read and user.profile:update"},"access_token":{"type":"string","example":"oa_nj1dfhecrs1jwxi0wd0xk49n","description":"The access token that can be used to obtain account and profile information"},"token_type":{"type":"string","example":"bearer","description":"Token type to be used in the Authorization header when requesting the resource's owner information"},"expires_in":{"type":"number","example":3600,"description":"The lifetime in seconds of the access token"},"user_id":{"type":"string","example":"1234567890","description":"Zephr user identifier"}}}},"components/schemas/oauth2-token-exchange-response":{"id":"components/schemas/oauth2-token-exchange-response","kind":"json-schema","title":"oauth2-token-exchange-response","data":{"type":"object","properties":{"scope":{"type":"string","example":"user.account:read user.profile:read user.profile:update","description":"The scope of the access request. Supported scopes: user.account:read, user.profile:read and user.profile:update"},"access_token":{"type":"string","example":"oa_nj1dfhecrs1jwxi0wd0xk49n","description":"The access token that can be used to obtain account and profile information"},"token_type":{"type":"string","example":"bearer","description":"Token type to be used in the Authorization header when requesting the resource's owner information"},"expires_in":{"type":"number","example":3600,"description":"The lifetime in seconds of the access token"},"refresh_token":{"type":"string","example":"6kuabo4gug8t9h13x7gt43cm"},"user_id":{"type":"string","example":"1234567890","description":"Zephr user identifier"}}}},"components/schemas/pagination-link":{"id":"components/schemas/pagination-link","kind":"json-schema","title":"pagination-link","data":{"type":"object","properties":{"url":{"type":"string","description":"The link's url","example":"https://example.com?rpp=10"},"page":{"type":"number","description":"The page number the link is pointing to","example":1}}}},"components/schemas/user-export-paginated-response":{"id":"components/schemas/user-export-paginated-response","kind":"json-schema","title":"user-export-paginated-response","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/user-export-response-items"}},"meta":{"type":"object","properties":{"count":{"type":"number","example":100},"rpp":{"type":"number","example":20},"paginated":{"type":"boolean","example":true}}},"links":{"type":"object","properties":{"first":{"$ref":"#/components/schemas/pagination-link"},"last":{"$ref":"#/components/schemas/pagination-link"},"previous":{"$ref":"#/components/schemas/pagination-link"},"next":{"$ref":"#/components/schemas/pagination-link"}}}}}},"components/schemas/user-export-response-items":{"id":"components/schemas/user-export-response-items","kind":"json-schema","title":"user-export-response-items","data":{"type":"array","items":{"$ref":"#/components/schemas/user-export-response-item"}}},"components/schemas/user-export-response-item":{"id":"components/schemas/user-export-response-item","kind":"json-schema","title":"user-export-response-item","data":{"type":"object","required":["user"],"properties":{"seq-no":{"type":"number","example":1},"user":{"$ref":"#/components/schemas/user-export-user"},"grants":{"$ref":"#/components/schemas/grants-response"}}}},"components/schemas/user-export-user":{"id":"components/schemas/user-export-user","kind":"json-schema","title":"user-export-user","data":{"type":"object","required":["identifiers"],"properties":{"identifiers":{"$ref":"#/components/schemas/identifiers"},"attributes":{"$ref":"#/components/schemas/attributes"}}}},"components/schemas/user-creation":{"id":"components/schemas/user-creation","kind":"json-schema","title":"user-creation","data":{"type":"object","properties":{"validators":{"$ref":"#/components/schemas/legacy-validators"},"identifiers":{"$ref":"#/components/schemas/identifiers"},"attributes":{"$ref":"#/components/schemas/attributes"},"accountMembershipCode":{"type":"string"},"email_verified":{"type":"boolean"},"last_login":{"type":"string"},"tracking_id":{"type":"string"},"registered":{"type":"string"},"registration_state":{"type":"object","properties":{"partial":{"type":"string"},"complete":{"type":"string"},"contact":{"type":"string"}}},"registration_tenant":{"type":"string"},"session_limit":{"type":"integer"},"foreign_keys":{"type":"array","items":{"type":"object"}},"product_sharing_id":{"type":"string"},"created_at":{"type":"string"}},"required":["identifiers"],"example":{"user_id":"123456789ABCD","identifiers":{"email_address":"joe.blow@company.com"},"attributes":{"first_name":"Joe","surname":"Blow","email_verified":true}}}},"components/schemas/legacy-validators":{"id":"components/schemas/legacy-validators","kind":"json-schema","title":"legacy-validators","data":{"type":"object","properties":{"password":{"type":"string"},"legacy_password":{"type":"string","description":"Legacy Passowrd is used only if the tenant has Login extension active. More information can be found here https://docs.zuora.com/en/zephr/configuration--integrations/settings/extensions/login-extension"}},"description":"Validators are not required for user creation, users created without validators won't be able to sign into Zephr unless they follow a password reset flow, or being mapped as shadow users identified by a JWT."}},"components/schemas/attribute_search_filter":{"id":"components/schemas/attribute_search_filter","kind":"json-schema","title":"attribute_search_filter","data":{"type":"object","description":"An array of these filters can be specified to perform a search by various attributes.","properties":{"slug":{"type":"string","description":"The user attribute slug","example":"subscriber-id"},"operator":{"type":"string","enum":["is","is_not","contains","does_not_contain","starts_with","ends_with","has_any_value","is_unknown","checked","unchecked"],"description":"The operation to apply to search filters for fields that are not of type Number, Range, or Date.","example":"is"},"value":{"type":"object","description":"The value assigned to the user attribute. Supported types include string, boolean, integer, and double.","example":"123456"},"from":{"type":"object","description":"Used with Number, Range, or Date fields to specify the starting value of the search range.","example":"2025-01-01"},"to":{"type":"object","description":"Used with Number, Range, or Date fields to specify the ending value of the search range.","example":"2025-06-01"}}}},"components/schemas/search_by_attributes":{"id":"components/schemas/search_by_attributes","kind":"json-schema","title":"search_by_attributes","data":{"type":"array","items":{"$ref":"#/components/schemas/attribute_search_filter"}}},"components/schemas/validators":{"id":"components/schemas/validators","kind":"json-schema","title":"validators","data":{"type":"object","properties":{"password":{"type":"string"}}}},"components/schemas/identifiers":{"id":"components/schemas/identifiers","kind":"json-schema","title":"identifiers","data":{"type":"object","properties":{"email_address":{"type":"string","example":"joe.blow@company.com"}}}},"components/schemas/attributes":{"id":"components/schemas/attributes","kind":"json-schema","title":"attributes","data":{"type":"object","properties":{"first_name":{"type":"string","example":"Joe"},"surname":{"type":"string","example":"Blow"}}}},"components/schemas/schema-field":{"id":"components/schemas/schema-field","kind":"json-schema","title":"schema-field","data":{"type":"object","properties":{"slug":{"type":"string","example":"slug1"},"visibility":{"type":"string","enum":["PUBLIC"],"example":"PUBLIC"},"context":{"type":"string","example":"slug1"},"label":{"type":"string","example":"Test"},"internal-description":{"type":"string","example":"This is for testing"},"public-description":{"type":"string","example":"Please provide some info"},"required":{"type":"boolean"},"validation-expression":{"type":"string","example":"test"},"input-type":{"type":"string","example":"text","enum":["text","color","number","range","time","datetime","date","week","month","email","tel","url","password","select","checkbox","radio","textarea","hidden"]},"select-options":{"type":"string","example":"null"},"range-start":{"type":"number"},"range-end":{"type":"number","example":100},"range-step":{"type":"number","example":5},"decision-point":{"type":"boolean"},"publicly-writable":{"type":"boolean"},"form-use":{"type":"boolean"},"unit":{"type":"string","example":"unit"},"unit-position":{"type":"string","enum":["leading","trailing"]},"value-precision":{"type":"number"},"stat-direction":{"type":"string","enum":["ascending","descending"]}}}},"components/schemas/schemas":{"id":"components/schemas/schemas","kind":"json-schema","title":"schemas","data":{"type":"array","items":{"$ref":"#/components/schemas/schema-field"}}},"components/schemas/schema-field-deletion-response":{"id":"components/schemas/schema-field-deletion-response","kind":"json-schema","title":"schema-field-deletion-response","data":{"type":"object","properties":{"message":{"type":"string","example":"Field removed from schema successfully"}}}},"components/schemas/schema-field-creation-response":{"id":"components/schemas/schema-field-creation-response","kind":"json-schema","title":"schema-field-creation-response","data":{"type":"object","properties":{"message":{"type":"string","example":"Field added to user schema successfully"},"uri":{"type":"string","example":"http://host/v3/schema/users/slug"}}}},"components/schemas/user-response":{"id":"components/schemas/user-response","kind":"json-schema","title":"user-response","data":{"type":"object","properties":{"user_id":{"type":"string","example":"123456789ABCD"},"identifiers":{"$ref":"#/components/schemas/identifiers"},"attributes":{"$ref":"#/components/schemas/attributes"},"email_verified":{"type":"boolean","example":true}}}},"components/schemas/users-response":{"id":"components/schemas/users-response","kind":"json-schema","title":"users-response","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/user-response"}}}}},"components/schemas/sessions":{"id":"components/schemas/sessions","kind":"json-schema","title":"sessions","data":{"type":"array","items":{"$ref":"#/components/schemas/session"}}},"components/schemas/webhook-response":{"id":"components/schemas/webhook-response","kind":"json-schema","title":"webhook-response","data":{"type":"object","properties":{"webhook_id":{"type":"string","example":"01234567890ABCD"}}}},"components/schemas/webhook-request":{"id":"components/schemas/webhook-request","kind":"json-schema","title":"webhook-request","data":{"type":"object","properties":{"label":{"type":"string","example":"Test webhook"},"triggers":{"type":"array","items":{}},"method":{"type":"string","example":"POST"},"target":{"type":"string","example":"http://localhost:9999"}}}},"components/schemas/webhooks-responses":{"id":"components/schemas/webhooks-responses","kind":"json-schema","title":"webhooks-responses","data":{"type":"object","properties":{"webhook-response":{"$ref":"#/components/schemas/webhook-response"},"webhook-request":{"$ref":"#/components/schemas/webhook-request"}}}},"components/schemas/webhook-responses-container":{"id":"components/schemas/webhook-responses-container","kind":"json-schema","title":"webhook-responses-container","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/webhooks-responses"}}}}},"components/schemas/Create_AccountBody":{"id":"components/schemas/Create_AccountBody","kind":"json-schema","title":"Create_AccountBody","data":{"type":"object","properties":{"company_id":{"type":"string"},"name":{"type":"string"},"number_of_seats":{"type":"number"},"allow_oversubscription":{"type":"boolean"},"notify_when_account_oversubscribed":{"type":"boolean"},"notify_on_each_registration_when_account_is_oversubscribed":{"type":"boolean"},"registration_code":{"type":"string"},"on_premises_ips":{"type":"string","description":"A list of newline-separated IP addresses or CIDR blocks that identify the premises associated with this account."},"premises_tags":{"type":"string","description":"(string) A JSON array of strings of 'tags'. Tags can be used to identify and group accounts to drive behaviour in the Zephr decision engine."},"session_limit":{"type":"number","description":"The maximum number of concurrent sessions that users of this account can have. If unspecified, the system default value is used. If a user belongs to multiple accounts, the highest limit is used."},"session_limit_behaviour":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of \"PREVENT_LOGIN\" or \"DELETE_OLDEST_SESSIONS\". Specifies the behaviour when a user of this account exceeds the configured limit of concurrent sessions."},"children":[]}]}]}]}},"example":{"company_id":"123456789ABCD","name":"Account name","number_of_seats":5,"allow_oversubscription":true,"notify_when_account_oversubscribed":true,"notify_on_each_registration_when_account_is_oversubscribed":true,"registration_code":"Registration code","on_premises_ips":"125.124.143.24","premises_tags":"[\"gold-tier\", \"university\"]","session_limit":10,"session_limit_behaviour":"PREVENT_LOGIN"}}},"components/schemas/response_simple_accountbody":{"id":"components/schemas/response_simple_accountbody","kind":"json-schema","title":"response_simple_accountbody","data":{"type":"object","properties":{"tenant_id":{"type":"string","example":"my-tenant"},"account_id":{"type":"string","example":"10549fef-cddb-4b1f-92e4-27ab7cb2e555"},"name":{"type":"string","example":"My Company"},"number_of_seats":{"type":"number","example":7},"email_address":{"type":"string","example":"company@email.com"}}}},"components/schemas/response_accountbody":{"id":"components/schemas/response_accountbody","kind":"json-schema","title":"response_accountbody","data":{"type":"object","properties":{"company_id":{"type":"string"},"name":{"type":"string"},"number_of_seats":{"type":"number"},"allow_oversubscription":{"type":"boolean"},"notify_when_account_oversubscribed":{"type":"boolean"},"notify_on_each_registration_when_account_is_oversubscribed":{"type":"boolean"},"registration_code":{"type":"string"},"ip_addresses":{"type":"string"},"registration_domains":{"type":"string"},"email_address":{"type":"string"},"on_premises_ips":{"type":"string","description":"A list of newline-separated IP addresses or CIDR blocks that identify the premises associated with this account."},"premises_tags":{"type":"string","description":"(string) A JSON array of strings of 'tags'. Tags can be used to identify and group accounts to drive behaviour in the Zephr decision engine."},"session_limit":{"type":"number","description":"The maximum number of concurrent sessions that users of this account can have. If unspecified, the system default value is used. If a user belongs to multiple accounts, the highest limit is used."},"session_limit_behaviour":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of \"PREVENT_LOGIN\" or \"DELETE_OLDEST_SESSIONS\". Specifies the behaviour when a user of this account exceeds the configured limit of concurrent sessions."},"children":[]}]}]}]},"branding":{"type":"object","properties":{"logoUrl":{"type":"string"},"urlPath":{"type":"string"},"pageIds":{"type":"array","items":{"type":"string"}},"openIdConfig":{"type":"object"}}}}}},"components/schemas/account_bodies":{"id":"components/schemas/account_bodies","kind":"json-schema","title":"account_bodies","data":{"type":"object","description":"A container object holding an array of full account objects.","properties":{"results":{"type":"array","description":"A list of account objects.","items":{"$ref":"#/components/schemas/response_accountbody"}}}}},"components/schemas/simple_account_bodies":{"id":"components/schemas/simple_account_bodies","kind":"json-schema","title":"simple_account_bodies","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/response_simple_accountbody"}},"total":{"type":"number","example":30,"description":"The total number of items out of which only a subset was returned  in the paginated results."}}}},"components/schemas/User_Segments_Response":{"id":"components/schemas/User_Segments_Response","kind":"json-schema","title":"User_Segments_Response","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/User_Segment_Response"}}}}},"components/schemas/User_Segment_Response":{"id":"components/schemas/User_Segment_Response","kind":"json-schema","title":"User_Segment_Response","data":{"type":"object","properties":{"id":{"type":"string","description":"The User Segment id."},"label":{"type":"string","description":"The User Segment label."},"description":{"type":"string","description":"The User Segment description."},"active":{"description":"The User Segment active status.","type":"boolean"},"archived":{"type":"boolean","description":"The User Segment archive status."}}}},"components/schemas/Bulk_User_Update_Response":{"id":"components/schemas/Bulk_User_Update_Response","kind":"json-schema","title":"Bulk_User_Update_Response","data":{"type":"object","properties":{"message":{"type":"string","description":"Returned message indicating the status of the operation."},"job_id":{"type":"string","description":"Id of the job."}}}},"components/schemas/Get_Bulk_User_Update_Job_Response":{"id":"components/schemas/Get_Bulk_User_Update_Job_Response","kind":"json-schema","title":"Get_Bulk_User_Update_Job_Response","data":{"type":"object","properties":{"jobId":{"type":"string"},"status":{"type":"string"},"jobDate":{"type":"string"},"succeeded":{"type":"number"},"errors":{"type":"number"},"total":{"type":"number"},"details":{"type":"object","description":"Lists details of each update job, including Id or foreign key, job status, and returned message.\n"}}}},"components/schemas/Get_Bulk_User_Update_Jobs_Item":{"id":"components/schemas/Get_Bulk_User_Update_Jobs_Item","kind":"json-schema","title":"Get_Bulk_User_Update_Jobs_Item","data":{"type":"object","properties":{"jobId":{"type":"string"},"status":{"type":"string"},"jobDate":{"type":"string"},"succeeded":{"type":"number"},"errors":{"type":"number"},"total":{"type":"number"}}}},"components/schemas/Get_Bulk_User_Update_Jobs_Response":{"id":"components/schemas/Get_Bulk_User_Update_Jobs_Response","kind":"json-schema","title":"Get_Bulk_User_Update_Jobs_Response","data":{"type":"array","items":{"$ref":"#/components/schemas/Get_Bulk_User_Update_Jobs_Item"}}},"components/schemas/bulk_update_object":{"id":"components/schemas/bulk_update_object","kind":"json-schema","title":"bulk_update_object","data":{"type":"object","properties":{"identifier":{"type":"object","description":"Identifier of the user. User either the User ID or Foreign Key.\n","properties":{"user_id":{"type":"string","description":"Unique Id of the user.\n"},"foreign_key":{"type":"object","description":"Foreign key object.","properties":{"foreign-system":{"type":"string","description":"The foreign key of the user.\n"}}}}},"actions":{"type":"array","description":"The actions to be taken for the user. Available actions are attribute update and user deletion.\n","items":{"$ref":"#/components/schemas/bulk_update_object_action_object"}}}}},"components/schemas/bulk_update_object_action_object":{"id":"components/schemas/bulk_update_object_action_object","kind":"json-schema","title":"bulk_update_object_action_object","data":{"type":"object","properties":{"type":{"type":"string","description":"The user update action to be taken.\n","enum":["delete-user","set-attribute"]},"attribute":{"type":"object","description":"Details of the attribute update.\n","properties":{"field":{"type":"string","description":"The slug of the attribute.\n"},"value":{"type":"string","description":"The updated value of the attribute.\n"}},"required":["field","value"]}}}},"components/schemas/promo-code-redemption-result":{"id":"components/schemas/promo-code-redemption-result","kind":"json-schema","title":"promo-code-redemption-result","data":{"type":"object","properties":{"promoCode":{"type":"string","description":"The promo code of the redemption result."},"success":{"type":"boolean","description":"Displays whether the promo code was successfully redeemed."},"errorMessage":{"type":"string","nullable":true,"description":"The reason for redemption failure, if unsuccessful."}}}},"components/schemas/add-bulk-account-users-by-domains":{"id":"components/schemas/add-bulk-account-users-by-domains","kind":"json-schema","title":"add-bulk-account-users-by-domains","data":{"type":"object","properties":{"tenantId":{"type":"string","example":"test_account_users"},"subTenantId":{"type":"string","example":"test_account_users"},"user_id":{"type":"string","example":"0123456789ABCD"},"account_id":{"type":"string","example":"0123456789ABCD"},"user_type":{"type":"string","example":"user"},"user_email":{"type":"string","example":"joe$RAND+2@yahoo.com"}}}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string"},"accountId":{"type":"string"}}}},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"email_address":{"type":"string"}}},"validators":{"type":"object","properties":{"password":{"type":"string"},"use_sso":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this is present there should be no identifiers in the body. The user is identified through a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blaize_session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cookie."},"children":[]}]}]}]}}}},"required":["identifiers"],"example":{"identifiers":{"email_address":"joe.blow@company.com"},"validators":{"password":"mysecurepassword123"}}},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"email_address":{"type":"string"}}},"validators":{"type":"object","properties":{"password":{"type":"string"},"use_sso":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this is present there should be no identifiers in the body. The user is identified through a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blaize_session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cookie."},"children":[]}]}]}]}}}},"required":["identifiers","validators"],"example":{"identifiers":{"email_address":"joe.blow@company.com"},"validators":{"password":"mysecurepassword123"}}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"object","properties":{"email":{"type":"string"},"role":{"type":"string"}},"required":["email","role"],"example":{"email":"admin@company.com","role":"role..."}},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"string"},"description":{"type":"string"},"includes":{"type":"object","properties":{"entitlements":{},"meters":{},"credits":{},"bundles":{}}},"auto_assign":{"type":"string"}},"example":{"label":"Test bundle","description":"This is a bundle","includes":{"entitlements":[],"meters":[],"credits":[],"bundles":[]},"auto_assign":"none"}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"properties":{"message":{"type":"string"}}},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"string"},"conditions":{"type":"object","properties":{"url_pattern":{"type":"string"},"header_patterns":{"type":"object","properties":{"Content-Type":{"type":"string"}}}}},"cache":{"type":"object","properties":{"origin":{"type":"boolean"},"decision_points":{"type":"boolean"}}}},"example":{"label":"Test","conditions":{"url_pattern":"^/forum","header_patterns":{"Content-Type":"^text/html"}},"cache":{"origin":false,"decision_points":false}}},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"object"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"website":{"type":"string"},"contact":{"type":"string"},"account_manager":{"type":"string"}},"example":{"name":"Company name","description":"Company description","website":"company.com","contact":"Company contact","account_manager":"Company account manager"}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the company"},"description":{"type":"string","description":"The description of the company"},"website":{"type":"string","description":"The website of the company"},"contact":{"type":"string","description":"Contact information of the company"},"account_manager":{"type":"string","description":"The name of the company account manager"}},"required":["name"],"example":{"name":"Company name","description":"Company description","website":"https://company.com","contact":"company@email.com","account_manager":"Joe Blow"}},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"object","properties":{"fileName":{"type":"string","description":"The name of the file. Unique file names are recommended but not enforced; the system generates a unique ID for each upload."},"contentType":{"type":"string","description":"The MIME type of the file. Supported MIME types include image/jpeg, image/png, and image/gif."}},"example":{"fileName":"unique-thumbnail.jpg","contentType":"image/jpeg"}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the uploaded thumbnail, used for referencing in the application."},"uploadUrl":{"type":"string","description":"The pre-signed URL for uploading the thumbnail."}}},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string"}}},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"object","properties":{"db.tables.extendedProfiles":{"type":"string"},"db.tables.grants":{"type":"string"},"db.tables.forms":{"type":"string"},"db.tables.features":{"type":"string"},"db.tables.requestRules":{"type":"string"},"db.tables.entitlements":{"type":"string"},"db.tables.formFields":{"type":"string"},"db.tables.companies":{"type":"string"},"db.tables.accounts":{"type":"string"},"db.tables.userSchemaFields":{"type":"string"},"db.tables.users":{"type":"string"},"db.tables.userAttributes":{"type":"string"},"db.tables.accountUsers":{"type":"string"},"db.tables.staticItems":{"type":"string"},"db.tables.webhooks":{"type":"string"},"db.tables.adminUserTenantRoles":{"type":"string"},"db.tables.adminUsers":{"type":"string"},"db.tables.adminKeyPairs":{"type":"string"},"oauth.google.apis.host":{"type":"string"},"oauth.linkedin.clientSecret":{"type":"string"},"oauth.linkedin.apis.host":{"type":"string"},"oauth.google.clientSecret":{"type":"string"},"oauth.google.callbackUri":{"type":"string"},"oauth.linkedin.clientId":{"type":"string"},"oauth.linkedin.callbackUri":{"type":"string"},"oauth.google.clientId":{"type":"string"},"oauth.facebook.callbackUri":{"type":"string"},"oauth.facebook.clientSecret":{"type":"string"},"oauth.facebook.apis.host":{"type":"string"},"oauth.facebook.clientId":{"type":"string"},"cdn.origin":{"type":"string"},"redis.port":{"type":"string"},"elasticsearch.url":{"type":"string"},"aws.region":{"type":"string"},"redis.host":{"type":"string"},"email.from":{"type":"string"},"authentication.password.requireEmailVerfication":{"type":"string"}},"example":{"db.tables.extendedProfiles":"value","db.tables.grants":"value","db.tables.forms":"value","db.tables.features":"value","db.tables.requestRules":"value","db.tables.entitlements":"value","db.tables.formFields":"value","db.tables.companies":"value","db.tables.accounts":"value","db.tables.userSchemaFields":"value","db.tables.users":"value","db.tables.userAttributes":"value","db.tables.accountUsers":"value","db.tables.staticItems":"value","db.tables.webhooks":"value","db.tables.adminUserTenantRoles":"value","db.tables.adminUsers":"value","db.tables.adminKeyPairs":"value","oauth.google.apis.host":"value","oauth.linkedin.clientSecret":"value","oauth.linkedin.apis.host":"value","oauth.google.clientSecret":"value","oauth.google.callbackUri":"value","oauth.linkedin.clientId":"value","oauth.linkedin.callbackUri":"value","oauth.google.clientId":"value","oauth.facebook.callbackUri":"value","oauth.facebook.clientSecret":"value","oauth.facebook.apis.host":"value","oauth.facebook.clientId":"value","cdn.origin":"value","redis.port":"value","elasticsearch.url":"value","aws.region":"value","redis.host":"value","email.from":"value","authentication.password.requireEmailVerfication":"value"}},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"string"},"private_key":{"type":"string"},"cert":{"type":"string"}},"example":{"label":"company.com","private_key":"private_key...","cert":"cert..."}},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"string"},"description":{"type":"string"},"delivers":{"type":"array","items":{}},"unit":{"type":"string"},"quantity":{"type":"number"},"auto_assign":{"type":"string"}},"example":{"label":"Test credit","description":"This is an credit","delivers":["ENTITLEMENT_ID"],"unit":"views","quantity":5,"auto_assign":"none"}},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"object","properties":{"path":{"type":"string"},"http_method":{"type":"string"},"session":{"type":"string"},"foreign_keys":{"type":"object","properties":{},"description":"Foreign system and ID used to identify the user"},"request_headers":{"type":"object","properties":{"User-Agent":{"type":"string"}}},"content_metadata":{"type":"object","properties":{"publishedDate":{"type":"string"}}},"jwt":{"type":"string"},"btr":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MD5-hex-encoding of: path + \"|\" + trusted referrer secret"},"children":[]}]}]}]}},"required":["path"],"example":{"path":"/x.html","http_method":"POST","session":"xxx-xxx-xxx","foreign_keys":{},"request_headers":{"User-Agent":"<userAgent>"},"content_metadata":{"publishedDate":"<contentAge>"},"jwt":"xxx-xxx-xxx","btr":"17e74b9e49e66282e55d4b7ec73de951"}},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"object","properties":{"templateType":{"type":"string"},"label":{"type":"string"},"subject":{"type":"string"},"content":{"type":"string"}},"example":{"templateType":"User Password Reset","label":"my modified default password reset","subject":"my modified default Password Reset Subject","content":"<p>New content</p>"}},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"string"},"description":{"type":"string"},"auto_assign":{"type":"string"}},"example":{"label":"Test entitlement","description":"This is an entitlement","auto_assign":"none"}},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"string","example":"tag1,tag2,tag3"},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"string"},"description":{"type":"string"},"requirements_script":{"type":"string"},"action_script":{"type":"string"},"script_type":{"type":"string"},"graph_state":{"type":"string"},"editing_mode":{"type":"string"}},"example":{"label":"Test feature","description":"Test feature","requirements_script":"return []","action_script":"return \"this is a test\"","script_type":"javascript","graph_state":"{\"property1\": \"value1\"}","editing_mode":"manual"}},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"array","items":{}},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"object","properties":{"title":{"type":"string"},"internal-description":{"type":"string"},"public-description":{"type":"string"},"registration":{"type":"boolean"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/field"}}},"example":{"title":"Test","internal-description":"This form is for testing","public-description":"Please provide some info","registration":true,"fields":[{"slug":"first-name","placeholder":"First name","required":true,"order":1}]}},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"Gift Id (passed as ?gift parameter in claim link)"},"created":{"type":"string","description":"UTC timestamp when gift was created"},"claimed":{"type":"string","description":"UTC timestamp when gift was claimed"},"uri":{"type":"string","description":"1823.html (string) - Path portion of URL gift will allow access to"},"cross_device_session":{"type":"string","description":"ID of cross-device session of claiming user (if claimed)"}},"example":{"id":"58c3852bb23f3467","created":"2018-04-27T09:15:28Z","uri":"/news/local/story"}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","properties":{"gift":{"type":"string","description":"id: 65c7da04b734a15f (string)"}}},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/grants-response"},{"$ref":"#/components/schemas/active-grants-response"}]},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"object","properties":{"entitlement_type":{"type":"string","enum":["bundle","entitlement","meter","credits"],"description":"An enum describing the type of the entitlement."},"entitlement_id":{"type":"string","example":"b3d8007e-6729-4faf-b7a9-46b6900eabd4"},"startTime":{"type":"string","example":"2022-06-01 00:00:00"},"endTime":{"type":"string","example":"2022-12-31 23:59:59"},"product_id":{"type":"string","example":"fffd4076-d0cd-45a4-89f3-56ae8aea31f0"}},"required":["entitlement_type","entitlement_id","product_id"],"example":{"entitlement_type":"bundle","entitlement_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","startTime":"2022-06-01 00:00:00","endTime":"2022-12-31 23:59:59","product_id":"XXXXXXXXXXXXXX"}},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/grant"}},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"string"},"description":{"type":"string"},"unit":{"type":"string"},"limit":{"type":"number"},"cycle":{"type":"string"},"period":{"type":"string"},"timezone":{"type":"string"},"auto_assign":{"type":"string"}},"example":{"label":"Test meter","description":"This is a meter","unit":"views","limit":5,"cycle":"calendar","period":"monthly","timezone":"+0:00","auto_assign":"none"}},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/products"}}}},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Product created successfully"},"uri":{"type":"string","example":"https://company.api.zephr.com/v3/products/63b68935-c996-4e90-b88a-dd6a133a7a3"}}},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Product updated successfully"},"uri":{"type":"string","example":"https://company.api.zephr.com/v3/products/gold"}}},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Product created successfully"},"uri":{"type":"string","example":"https://company.api.zephr.com/v3/products/gold"}}},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"string"},"conditions":{"type":"object","properties":{"url_pattern":{"type":"string"},"method":{"type":"string"}}},"requirements_script":{"type":"string"},"action_script":{"type":"string"},"script_type":{"type":"string"},"graph_state":{"type":"string"},"editing_mode":{"type":"string"}},"example":{"label":"Test","conditions":{"url_pattern":"^/forum","method":"GET"},"requirements_script":"return []","action_script":"return \"this is a test\"","script_type":"javascript","graph_state":"{\"property1\": \"value1\"}","editing_mode":"manual"}},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"object","oneOf":[{"required":["grant_type","refresh_token"],"properties":{"grant_type":{"type":"string","enum":["refresh_token"]},"refresh token":{"type":"string"}}},{"required":["grant_type","code","redirect_uri"],"properties":{"grant_type":{"type":"string","enum":["authorization_code"]},"code":{"type":"string"},"redirect_uri":{"type":"string","format":"uri"}}}]},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/oauth2-token-exchange-response"},{"$ref":"#/components/schemas/oauth2-token-refresh-response"}]},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"number","default":500},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"number","default":1},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"string","example":"123456"},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"$ref":"#/components/schemas/search_by_attributes"},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"object","properties":{"first_name":{"type":"string"},"surname":{"type":"string"}},"example":{"first_name":"Joe","surname":"Blow"}},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"User extended profile"}}},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"object","properties":{"updates":{"type":"array","description":"Array of combination of identifier and actions.\n","items":{"$ref":"#/components/schemas/bulk_update_object"}}}},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"string","description":"The User Segment name."},"description":{"type":"string","description":"The User Segment description."}},"required":["label"]},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"object","properties":{"new_identifiers":{"type":"object","properties":{"email_address":{"type":"string","pattern":".+@.+\\..+"}},"required":["email_address"]}},"required":["new_identifiers"],"example":{"new_identifiers":{"email_address":"joe.blow@company.com"}}},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"email_address":{"type":"string","example":"joe.blow@company.com"}}},"siteSlug":{"type":"string","description":"The slug of the site where the user account is registered.\n","example":"my-site"}},"required":["identifiers","siteSlug"],"example":{"identifiers":{"email_address":"joe.blow@company.com"},"siteSlug":"my-site"}},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"email_address":{"type":"string"}}},"delivery":{"type":"object","properties":{"method":{"type":"string"},"destination":{"type":"string"},"action":{"type":"string"},"redirect":{"type":"string"}}}},"required":["identifiers","delivery"],"example":{"identifiers":{"email_address":"joe.blow@company.com"},"delivery":{"method":"email","destination":"joe.blow@company.com","action":"login","redirect":"/"}}},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/session-lookup"},{"$ref":"#/components/schemas/sessions"}]},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/account-user"}},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"string"},"triggers":{"type":"array","items":{}},"method":{"type":"string"},"target":{"type":"string"}},"example":{"label":"Test webhook","triggers":["user.create","user.delete"],"method":"POST","target":"http://localhost:9999"}},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"object","properties":{"webhook_id":{"type":"string"},"label":{"type":"string"},"triggers":{"type":"array","items":{}},"method":{"type":"string"},"target":{"type":"string"}},"example":{"webhook_id":"01234567890ABCD","label":"Test webhook","triggers":["user.create","user.delete"],"method":"POST","target":"http://localhost:9999"}},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"number","example":15,"default":10},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"type":"string","example":"My account"},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"object","example":"{ Resource updated successfully resourceID }"},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"object","properties":{"logoId":{"type":"string","example":"857945ea-b4e1-4fba-84ce-73755d987243","description":"The generated ID for the page logo"},"uploadUrl":{"type":"string","example":"https://s3.amazonaws.com/test-bucket/2022/test.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA3SGQVQG7FGA6KKA6%2F20221104%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20221104T140227Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=b228dbec8c1008c80c162e1210e4503dceead1e4d4751b4d9787314fd6da4d55","description":"The generated presigned S3 upload URL"}}},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"object","properties":{"promo_codes":{"type":"array","description":"A list of promo codes that can be redeemed.","items":{"type":"string"}}}},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/promo-code-redemption-result"}}}},"id":"schema_60"}},"exampleStore":{"paths/~1v3~1accounts~1{account_id}~1users/get/responses/200/content/application~1json/examples/response":{"value":[{"user_id":"0123456789ABCD","account_id":"0123456789ABCD"}],"key":"response","summary":"response","id":"paths/~1v3~1accounts~1{account_id}~1users/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/get/responses/200/content/application~1json/examples/response":{"value":{"user_id":"0123456789ABCD","account_id":"0123456789ABCD"},"key":"response","summary":"response","id":"paths/~1v3~1accounts~1{account_id}~1users~1{user_id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v4~1accounts~1{accountId}~1grants/get/responses/200/content/application~1json/examples/response":{"value":[{"userId":"3f589a2d-86ad-4b70-a5df-68dca75a3a21","accountId":"5fag4a2d-86cd-4bb0-a5df-68dca75a3a21"}],"key":"response","summary":"response","id":"paths/~1v4~1accounts~1{accountId}~1grants/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1admin~1users/post/responses/201/content/application~1json/examples/response":{"value":{"user_id":"b859f5dd-8184-4d01-8bf9-e3e771f68a62","message":"Admin user created successfully","uri":"http://company.com/v3/admin/users/b859f5dd-8184-4d01-8bf9-e3e771f68a62"},"key":"response","summary":"response","id":"paths/~1v3~1admin~1users/post/responses/201/content/application~1json/examples/response"},"paths/~1v3~1admin~1login/post/responses/200/content/application~1json/examples/response":{"value":{"cookie":"blaize_admin_session=...","message":"Login successful"},"key":"response","summary":"response","id":"paths/~1v3~1admin~1login/post/responses/200/content/application~1json/examples/response"},"paths/~1v3~1admin~1logout/post/responses/200/content/application~1json/examples/response":{"value":{"message":"Session deleted"},"key":"response","summary":"response","id":"paths/~1v3~1admin~1logout/post/responses/200/content/application~1json/examples/response"},"paths/~1v3~1admin~1users~1{user_id}~1keypairs/post/responses/201/content/application~1json/examples/response":{"value":{"access_key":"access key...","secret_key":"secret key...","message":"Keypair created: you will not be able to recover the secret, so take note of it"},"key":"response","summary":"response","id":"paths/~1v3~1admin~1users~1{user_id}~1keypairs/post/responses/201/content/application~1json/examples/response"},"paths/~1v3~1admin~1users~1{user_id}~1keypairs/get/responses/200/content/application~1json/examples/response":{"value":[{"access_key":"access key..."}],"key":"response","summary":"response","id":"paths/~1v3~1admin~1users~1{user_id}~1keypairs/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1admin~1users~1{user_id}~1keypairs~1{access_key}/delete/responses/200/content/application~1json/examples/response":{"value":{"message":"Keypair revoked"},"key":"response","summary":"response","id":"paths/~1v3~1admin~1users~1{user_id}~1keypairs~1{access_key}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v3~1admin~1users~1{user_id}~1roles/get/responses/200/content/application~1json/examples/response":{"value":[{"email":"admin@company.com","role":"role..."}],"key":"response","summary":"response","id":"paths/~1v3~1admin~1users~1{user_id}~1roles/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1admin~1users~1{user_id}~1roles~1{tenant}/get/responses/200/content/application~1json/examples/response":{"value":[{"email":"admin@company.com","role":"role..."}],"key":"response","summary":"response","id":"paths/~1v3~1admin~1users~1{user_id}~1roles~1{tenant}/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1admin~1roles/post/responses/201/content/application~1json/examples/response":{"value":{"message":"Admin role created successfully"},"key":"response","summary":"response","id":"paths/~1v3~1admin~1roles/post/responses/201/content/application~1json/examples/response"},"paths/~1v3~1admin~1roles/get/responses/200/content/application~1json/examples/response":{"value":[{"role_id":"0123456789ABCD","email":"admin@company.com","role":"role..."}],"key":"response","summary":"response","id":"paths/~1v3~1admin~1roles/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1admin~1roles~1{role_id}/put/responses/200/content/application~1json/examples/response":{"value":{"message":"Admin role updated successfully"},"key":"response","summary":"response","id":"paths/~1v3~1admin~1roles~1{role_id}/put/responses/200/content/application~1json/examples/response"},"paths/~1v3~1admin~1roles~1{role_id}/get/responses/200/content/application~1json/examples/response":{"value":{"role_id":"0123456789ABCD","email":"admin@company.com","role":"role..."},"key":"response","summary":"response","id":"paths/~1v3~1admin~1roles~1{role_id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1admin~1roles~1{role_id}/delete/responses/200/content/application~1json/examples/response":{"value":{"message":"Admin role deleted successfully"},"key":"response","summary":"response","id":"paths/~1v3~1admin~1roles~1{role_id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v3~1admin~1sessions~1{blaize_admin_session_id}/get/responses/200/content/application~1json/examples/response":{"value":{"user_id":"123456789ABCD"},"key":"response","summary":"response","id":"paths/~1v3~1admin~1sessions~1{blaize_admin_session_id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1bundles~1{id}/delete/responses/200/content/application~1json/examples/response":{"value":{"message":"Bundle deleted successfully"},"key":"response","summary":"response","id":"paths/~1v3~1bundles~1{id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v3~1cache-configurations/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"label":"Test","conditions":{"url_pattern":"^/forum","header_patterns":{"Content-Type":"^text/html"}},"cache":{"origin":false,"decision_points":false},"redirect":{"on":false,"target":"/some/path","status":301}}]},"key":"response","summary":"response","id":"paths/~1v3~1cache-configurations/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1cache-configurations~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"label":"Test","conditions":{"url_pattern":"^/forum","header_patterns":{"Content-Type":"^text/html"}},"cache":{"origin":false,"decision_points":false},"redirect":{"on":false,"target":"/some/path","status":301}},"key":"response","summary":"response","id":"paths/~1v3~1cache-configurations~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1cache-management~1evict-origin/post/requestBody/content/application~1json/example":{"value":"1 line containing valid Java Regular Expression.","id":"paths/~1v3~1cache-management~1evict-origin/post/requestBody/content/application~1json/example"},"paths/~1v4~1cache-management~1evict-origin/post/requestBody/content/application~1json/example":{"value":"1 line containing valid Java Regular Expression.","id":"paths/~1v4~1cache-management~1evict-origin/post/requestBody/content/application~1json/example"},"paths/~1v4~1cache-management~1evict-origin~1{site}/post/requestBody/content/application~1json/example":{"value":"1 line containing valid Java Regular Expression.","id":"paths/~1v4~1cache-management~1evict-origin~1{site}/post/requestBody/content/application~1json/example"},"paths/~1v3~1companies/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"name":"Company name","description":"Company description","website":"company.com","contact":"Company contact","account_manager":"Company account manager"}]},"key":"response","summary":"response","id":"paths/~1v3~1companies/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1companies~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"name":"Company name","description":"Company description","website":"company.com","contact":"Company contact","account_manager":"Company account manager"},"key":"response","summary":"response","id":"paths/~1v3~1companies~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v4~1companies~1{companyId}/get/responses/200/content/application~1json/example":{"value":{"company_id":"1f6841a8-7f3b-4505-856e-4549be433545","name":"My Company","description":"This is an example company","website":"https://company.com","contact":"email@company.com","account_manager":"Joe Blow","tenantId":"my-tenant","subTenantId":"my-tenant"},"id":"paths/~1v4~1companies~1{companyId}/get/responses/200/content/application~1json/example"},"paths/~1v4~1thumbnails~1upload-url/post/responses/200/content/application~1json/examples/application~1json":{"value":{"id":"4f5c49a5-e433-4ac1-b0ad-d67897988899","uploadUrl":"https://zephr-thumbnails.s3.amazonaws.com/{generated-path}?..."},"key":"application/json","summary":"application/json","id":"paths/~1v4~1thumbnails~1upload-url/post/responses/200/content/application~1json/examples/application~1json"},"paths/~1v4~1thumbnails~1upload-url/post/responses/400/content/application~1json/examples/missingName":{"value":{"error":"Please provide name of file to upload"},"key":"missingName","summary":"missingName","id":"paths/~1v4~1thumbnails~1upload-url/post/responses/400/content/application~1json/examples/missingName"},"paths/~1v4~1thumbnails~1upload-url/post/responses/400/content/application~1json/examples/invalidType":{"value":{"error":"Unsupported MIME type provided"},"key":"invalidType","summary":"invalidType","id":"paths/~1v4~1thumbnails~1upload-url/post/responses/400/content/application~1json/examples/invalidType"},"paths/~1v4~1thumbnails~1upload-url/post/responses/401/content/application~1json/examples/missingCredentials":{"value":{"error":"Authentication credentials are required"},"key":"missingCredentials","summary":"missingCredentials","id":"paths/~1v4~1thumbnails~1upload-url/post/responses/401/content/application~1json/examples/missingCredentials"},"paths/~1v3~1configuration/get/responses/200/content/application~1json/examples/response":{"value":{"db.tables.extendedProfiles":"value","db.tables.grants":"value","db.tables.forms":"value","db.tables.features":"value","db.tables.requestRules":"value","db.tables.entitlements":"value","db.tables.formFields":"value","db.tables.companies":"value","db.tables.accounts":"value","db.tables.userSchemaFields":"value","db.tables.users":"value","db.tables.userAttributes":"value","db.tables.accountUsers":"value","db.tables.staticItems":"value","db.tables.webhooks":"value","db.tables.adminUserTenantRoles":"value","db.tables.adminUsers":"value","db.tables.adminKeyPairs":"value","oauth.google.apis.host":"value","oauth.linkedin.clientSecret":"value","oauth.linkedin.apis.host":"value","oauth.google.clientSecret":"value","oauth.google.callbackUri":"value","oauth.linkedin.clientId":"value","oauth.linkedin.callbackUri":"value","oauth.google.clientId":"value","oauth.facebook.callbackUri":"value","oauth.facebook.clientSecret":"value","oauth.facebook.apis.host":"value","oauth.facebook.clientId":"value","cdn.origin":"value","redis.port":"value","elasticsearch.url":"value","aws.region":"value","redis.host":"value","email.from":"value","authentication.password.requireEmailVerfication":"value"},"key":"response","summary":"response","id":"paths/~1v3~1configuration/get/responses/200/content/application~1json/examples/response"},"paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/singleDomain":{"value":["spam.com"],"key":"singleDomain","summary":"singleDomain","id":"paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/singleDomain"},"paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/multipleDomains":{"value":["spam.com","disposable-email.com","temporary-mail.net"],"key":"multipleDomains","summary":"multipleDomains","id":"paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/multipleDomains"},"paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/emptyList":{"value":[],"key":"emptyList","summary":"emptyList","id":"paths/~1v4~1blacklisted-email-domains/put/requestBody/content/application~1json/examples/emptyList"},"paths/~1v4~1blacklisted-email-domains/put/responses/200/content/application~1json/examples/response":{"value":{"message":"Blacklisted email domains updated successfully"},"key":"response","summary":"response","id":"paths/~1v4~1blacklisted-email-domains/put/responses/200/content/application~1json/examples/response"},"paths/~1v4~1blacklisted-email-domains/put/responses/201/content/application~1json/examples/response":{"value":{"message":"Blacklisted email domains created successfully"},"key":"response","summary":"response","id":"paths/~1v4~1blacklisted-email-domains/put/responses/201/content/application~1json/examples/response"},"paths/~1v4~1blacklisted-email-domains/get/responses/200/content/application~1json/examples/response":{"value":["testapi@test.com","someother@domain.com","hello@hello.co.uk"],"key":"response","summary":"response","id":"paths/~1v4~1blacklisted-email-domains/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1credits/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"label":"Test credit","description":"This is an credit","delivers":["ENTITLEMENT_ID"],"unit":"views","quantity":5,"auto_assign":"none"}]},"key":"response","summary":"response","id":"paths/~1v3~1credits/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1credits~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"label":"Test credit","description":"This is an credit","delivers":["ENTITLEMENT_ID"],"unit":"views","quantity":5,"auto_assign":"none"},"key":"response","summary":"response","id":"paths/~1v3~1credits~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1decision-engine/post/responses/200/content/application~1json/examples/response":{"value":{"status":"301","body":"Redirecting to login page...","headers":{"Location":"/login.html"}},"key":"response","summary":"response","id":"paths/~1v3~1decision-engine/post/responses/200/content/application~1json/examples/response"},"paths/~1v4~1email-templates/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"templateType":"template type","slug":"email template slug","label":"Name of the email template","subject":"Email subject","content":"Email content","default":false}]},"key":"response","summary":"response","id":"paths/~1v4~1email-templates/get/responses/200/content/application~1json/examples/response"},"paths/~1v4~1email-templates~1{slug}/get/responses/200/content/application~1json/examples/response":{"value":{"templateType":"template type","slug":"email template slug","label":"Name of the email template","subject":"Email subject","content":"Email content","default":false},"key":"response","summary":"response","id":"paths/~1v4~1email-templates~1{slug}/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1entitlements/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"label":"Test entitlement","description":"This is an entitlement","auto_assign":"none"}]},"key":"response","summary":"response","id":"paths/~1v3~1entitlements/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1entitlements~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"label":"Test entitlement","description":"This is an entitlement","auto_assign":"none"},"key":"response","summary":"response","id":"paths/~1v3~1entitlements~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1feature-rules/get/responses/200/content/application~1json/examples/response":{"value":[{"id":"featureRuleId","version":1,"tags":[],"label":"Test feature","description":"Test feature","last_updated":"2011-11-11T11:11:11.000","request_type":"json","target_name":"article","match_operation":"equals","target_value":"home_button"}],"key":"response","summary":"response","id":"paths/~1v3~1feature-rules/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1feature-rules~1{featureRuleId}~1versions/get/responses/200/content/application~1json/examples/response":{"value":[{"id":"featureRuleId","version":1,"tags":[],"label":"Test feature","description":"Test feature","last_updated":"2011-11-11T11:11:11.000"}],"key":"response","summary":"response","id":"paths/~1v3~1feature-rules~1{featureRuleId}~1versions/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1feature-rules~1{featureRuleId}~1versions/post/responses/201/content/application~1json/examples/response":{"value":{"message":"Feature Rule created successfully","uri":"http://host/v3/feature-rules/featureRuleId/versions"},"key":"response","summary":"response","id":"paths/~1v3~1feature-rules~1{featureRuleId}~1versions/post/responses/201/content/application~1json/examples/response"},"paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"featureRuleId","version":1,"tags":[],"label":"Test feature","description":"Test feature","requirements_script":"return []","action_script":"return \"this is a test\"","script_type":"javascript","graph_state":"{\"property1\": \"value1\"}","editing_mode":"manual","last_updated":"2011-11-11T11:11:11.000"},"key":"response","summary":"response","id":"paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}~1tags/put/responses/201/content/application~1json/examples/response":{"value":{"message":"featureRuleId tag/s saved successfully","uri":"http://host/v3/feature-rules/featureRuleId/versions/versionId/tags"},"key":"response","summary":"response","id":"paths/~1v3~1feature-rules~1{featureRuleId}~1versions~1{versionId}~1tags/put/responses/201/content/application~1json/examples/response"},"paths/~1v3~1forms/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"title":"Test","internal-description":"This form is for testing","public-description":"Please provide some info","registration":true,"fields":[{"slug":"first-name","placeholder":"First name","required":true,"order":1}]}]},"key":"response","summary":"response","id":"paths/~1v3~1forms/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1forms~1{slug}/get/responses/200/content/application~1json/examples/response":{"value":{"title":"Test","internal-description":"This form is for testing","public-description":"Please provide some info","registration":true,"fields":[{"slug":"first-name","placeholder":"First name","required":true,"order":1}]},"key":"response","summary":"response","id":"paths/~1v3~1forms~1{slug}/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1gift/get/responses/200/content/application~1json/examples/response":{"value":[{"id":"58c3852bb23f3467","created":"2018-04-27T09:15:28Z","uri":"/news/local/story"}],"key":"response","summary":"response","id":"paths/~1v3~1gift/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1users~1{userId}~1grants/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"grant_id":"5700aae1-461d-47d7-9a4c-d84412da7053","user_id":"16b26d63-4ee9-4955-9d8b-f6625300d040","entitlement_type":"bundle","entitlement_id":"cae85210-c942-490f-a24a-614033c51e49","expiry_state":"active","startTime":"2024-02-01 00:00:00","endTime":"2025-02-01 23:59:59","created_at":"2024-02-01 00:00:00","product_id":"gold"}]},"key":"response","summary":"response","id":"paths/~1v3~1users~1{userId}~1grants/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1users~1{userId}~1accessModel/get/responses/200/content/application~1json/examples/response":{"value":{"meters":{},"credits":{},"delivered_entitlements":[{"id":"0123456789ABCD","direct":true,"meteredBy":[],"creditedBy":[]}]},"key":"response","summary":"response","id":"paths/~1v3~1users~1{userId}~1accessModel/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1accounts~1{accountId}~1grants~1{grantId}/get/responses/200/content/application~1json/examples/response":{"value":{"grantId":"0123456789ABCD","entitlement_type":"bundle","entitlement_id":"8dfb3e7c-7a9e-4f23-b6c1-e2d8c41fb9a8","startTime":"2022-06-01 00:00:00","endTime":"2022-12-31 23:59:59","product_id":"PRD-2024-ABC123"},"key":"response","summary":"response","id":"paths/~1v3~1accounts~1{accountId}~1grants~1{grantId}/get/responses/200/content/application~1json/examples/response"},"paths/~1v4~1accounts~1{accountId}~1grants~1{grantId}/delete/responses/200/content/application~1json/examples/response":{"value":"Account grant revoked","key":"response","summary":"response","id":"paths/~1v4~1accounts~1{accountId}~1grants~1{grantId}/delete/responses/200/content/application~1json/examples/response"},"paths/~1v3~1meters/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"label":"Test meter","description":"This is a meter","unit":"views","limit":5,"cycle":"calendar","period":"monthly","timezone":"+0:00","auto_assign":"none"}]},"key":"response","summary":"response","id":"paths/~1v3~1meters/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1meters~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"label":"Test meter","description":"This is a meter","unit":"views","limit":5,"cycle":"calendar","period":"monthly","timezone":"+0:00","auto_assign":"none"},"key":"response","summary":"response","id":"paths/~1v3~1meters~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1products/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"id":"one","label":"One month access","description":"One month access","entitlement":{"id":"gold-bundle","type":"bundle"},"mapping":{"braintree_one_off":{"price_points":[{"id":"ten","label":"Ten Dollars","price":10}]}},"sharingLimit":0}]},"key":"response","summary":"response","id":"paths/~1v3~1products/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1request-rules/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"label":"Test","conditions":{"url_pattern":"^/forum","method":"GET"},"requirements_script":"return []","action_script":"return \"this is a test\"","script_type":"javascript","graph_state":"{\"property1\": \"value1\"}","editing_mode":"manual","version":1,"description":"Test description","priority":1,"last_updated":"2011-11-11T11:11:11.000"}]},"key":"response","summary":"response","id":"paths/~1v3~1request-rules/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1sessions/post/responses/200/content/application~1json/examples/response":{"value":{"expiryDate":"2018-11-15 14:29 PM UTC","startDate":"2017-11-15 14:29 PM UTC","authenticated":true,"session_id":"SS0123456789ABCD","user_id":"UU0123456789ABCD"},"key":"response","summary":"response","id":"paths/~1v3~1sessions/post/responses/200/content/application~1json/examples/response"},"paths/~1v3~1sessions~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"session_variables":{},"user_id":"UU0123456789ABCD","sessions":[{"expiryDate":"2018-11-15 14:29 PM UTC","startDate":"2017-11-15 14:29 PM UTC","authenticated":true,"session_id":"SS0123456789ABCD","user_id":"UU0123456789ABCD"}]},"key":"response","summary":"response","id":"paths/~1v3~1sessions~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1static/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"id":"123456789ABCD"}]},"key":"response","summary":"response","id":"paths/~1v3~1static/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1static~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"123456789ABCD","item":"Lorem ipsum..."},"key":"response","summary":"response","id":"paths/~1v3~1static~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1zephr~1oauth2~1token/post/requestBody/content/application~1json/examples/RefreshToken":{"value":{"grant_type":"refresh_token","refresh_token":"6kuabo4gug8t9h13x7gt43cm"},"key":"RefreshToken","summary":"Refresh token request","id":"paths/~1zephr~1oauth2~1token/post/requestBody/content/application~1json/examples/RefreshToken"},"paths/~1zephr~1oauth2~1token/post/requestBody/content/application~1json/examples/AuthorizationCode":{"value":{"grant_type":"authorization_code","code":1234567890,"redirect_uri":"https://someUrl.com/callback"},"key":"AuthorizationCode","summary":"Authorization code request","id":"paths/~1zephr~1oauth2~1token/post/requestBody/content/application~1json/examples/AuthorizationCode"},"paths/~1v3~1schema~1users/get/responses/200/content/application~1json/examples/response":{"value":[{"slug":"slug1","label":"Test","internal-description":"This is for testing","public-description":"Please provide some info","required":false,"decision-point":false,"validation-expression":"test","input-type":"text","select-options":"null","range-start":0,"range-end":100,"range-step":5}],"key":"response","summary":"response","id":"paths/~1v3~1schema~1users/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1schema~1users~1{slug}/put/responses/201/content/application~1json/examples/response":{"value":{"message":"Field added to user schema successfully","uri":"http://host/v3/schema/users/slug"},"key":"response","summary":"response","id":"paths/~1v3~1schema~1users~1{slug}/put/responses/201/content/application~1json/examples/response"},"paths/~1v3~1users~1{userId}~1foreign-key~1update~1{key}/put/requestBody/content/application~1json/example":{"value":"65xcb76a3a2f1","id":"paths/~1v3~1users~1{userId}~1foreign-key~1update~1{key}/put/requestBody/content/application~1json/example"},"paths/~1v4~1users~1{userId}~1foreign-key~1{key}~1{system}/delete/requestBody/content/application~1json/example":{"value":"65xcb76a3a2f1","id":"paths/~1v4~1users~1{userId}~1foreign-key~1{key}~1{system}/delete/requestBody/content/application~1json/example"},"paths/~1v3~1users/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"user_id":"123456789ABCD","identifiers":{"email_address":"joe.blow@company.com"},"attributes":{"first_name":"Joe","surname":"Blow"},"email_verified":true}]},"key":"response","summary":"response","id":"paths/~1v3~1users/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1users/post/responses/201/content/application~1json/examples/response":{"value":{"data":{"user_id":"123456789ABCD","identifiers":{"email_address":"joe.blow@company.com"},"attributes":{"first_name":"Joe","surname":"Blow"},"email_verified":true}},"key":"response","summary":"response","id":"paths/~1v3~1users/post/responses/201/content/application~1json/examples/response"},"paths/~1v3~1users~1{user_id}/get/responses/200/content/application~1json/examples/response":{"value":{"user_id":"123456789ABCD","identifiers":{"email_address":"joe.blow@company.com"},"attributes":{"first_name":"Joe","surname":"Blow"},"email_verified":true},"key":"response","summary":"response","id":"paths/~1v3~1users~1{user_id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v4~1user-updates/post/requestBody/content/application~1json/example":{"value":{"updates":[{"identifier":{"user_id":"string"},"actions":[{"type":"set-attribute","attribute":{"field":"string","value":"string"}}]},{"identifier":{"foreign_key":{"foreign-system":"string"}},"actions":[{"type":"delete-user"}]}]},"id":"paths/~1v4~1user-updates/post/requestBody/content/application~1json/example"},"paths/~1v4~1user-updates/post/responses/400/content/application~1json/examples/missingName":{"value":{"error":"Please provide name of file to upload"},"key":"missingName","summary":"missingName","id":"paths/~1v4~1user-updates/post/responses/400/content/application~1json/examples/missingName"},"paths/~1v4~1user-updates/post/responses/400/content/application~1json/examples/invalidType":{"value":{"error":"Unsupported MIME type provided"},"key":"invalidType","summary":"invalidType","id":"paths/~1v4~1user-updates/post/responses/400/content/application~1json/examples/invalidType"},"paths/~1v4~1user-updates/post/responses/401/content/application~1json/examples/missingCredentials":{"value":{"error":"Authentication credentials are required"},"key":"missingCredentials","summary":"missingCredentials","id":"paths/~1v4~1user-updates/post/responses/401/content/application~1json/examples/missingCredentials"},"paths/~1v3~1users~1{user_id}~1sessions/get/responses/200/content/application~1json/examples/response":{"value":{"session_variables":{},"user_id":"UU0123456789ABCD","sessions":[{"expiryDate":"2018-11-15 14:29 PM UTC","startDate":"2017-11-15 14:29 PM UTC","authenticated":true,"session_id":"SS0123456789ABCD","user_id":"UU0123456789ABCD"}],"access_model":{"meters":[],"credits":[],"delivered_entitlements":[]}},"key":"response","summary":"response","id":"paths/~1v3~1users~1{user_id}~1sessions/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1users~1{user_id}~1accounts/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"user_id":"0123456789ABCD","account_id":"0123456789ABCD"}]},"key":"response","summary":"response","id":"paths/~1v3~1users~1{user_id}~1accounts/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1users~1{user_id}~1authorization~1refresh/post/responses/200/content/application~1json/examples/response":{"value":{"meters":{},"credits":{},"delivered_entitlements":[{"id":"0123456789ABCD","direct":true,"meteredBy":[],"creditedBy":[]}]},"key":"response","summary":"response","id":"paths/~1v3~1users~1{user_id}~1authorization~1refresh/post/responses/200/content/application~1json/examples/response"},"paths/~1v3~1users~1{user_Id}~1legacyPassword/post/responses/200/content/application~1json/examples/response":{"value":{"message":"Legacy Password updated successfully to be used instead of password","user_id":"{userId}","uri":"http://localhost:8080/v3/users/{userId}/legacyPassword"},"key":"response","summary":"response","id":"paths/~1v3~1users~1{user_Id}~1legacyPassword/post/responses/200/content/application~1json/examples/response"},"paths/~1v4~1sessions~1{site}/post/responses/201/content/application~1json/examples/response":{"value":{"expiryDate":"2018-11-15 14:29 PM UTC","startDate":"2017-11-15 14:29 PM UTC","authenticated":true,"session_id":"SS0123456789ABCD","user_id":"UU0123456789ABCD"},"key":"response","summary":"response","id":"paths/~1v4~1sessions~1{site}/post/responses/201/content/application~1json/examples/response"},"paths/~1v4~1anonymous-sessions~1{site}/post/responses/200/content/application~1json/examples/response":{"value":{"expiryDate":"2018-11-15 14:29 PM UTC","startDate":"2017-11-15 14:29 PM UTC","authenticated":true,"session_id":"SS0123456789ABCD","user_id":"UU0123456789ABCD"},"key":"response","summary":"response","id":"paths/~1v4~1anonymous-sessions~1{site}/post/responses/200/content/application~1json/examples/response"},"paths/~1v3~1webhooks/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"webhook_id":"01234567890ABCD","label":"Test webhook","triggers":["user.create","user.delete"],"method":"POST","target":"http://localhost:9999"}]},"key":"response","summary":"response","id":"paths/~1v3~1webhooks/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1webhooks~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"webhook_id":"01234567890ABCD","label":"Test webhook","triggers":["user.create","user.delete"],"method":"POST","target":"http://localhost:9999"},"key":"response","summary":"response","id":"paths/~1v3~1webhooks~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1accounts/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"account_id":"10549fef-cddb-4b1f-92e4-27ab7cb2e555","name":"Account name","tenant_id":"my-tenant","number_of_seats":7,"email_address":"company@email.com"}],"total":20},"key":"response","summary":"response","id":"paths/~1v3~1accounts/get/responses/200/content/application~1json/examples/response"},"paths/~1v3~1accounts~1{id}/get/responses/200/content/application~1json/examples/response":{"value":{"company_id":"123456789ABCD","name":"Account name","number_of_seats":5,"allow_oversubscription":true,"notify_when_account_oversubscribed":true,"notify_on_each_registration_when_account_is_oversubscribed":true,"registration_code":"Registration code","on_premises_ips":"125.124.143.24","premises_tags":"[\"gold-tier\", \"university\"]","session_limit":10,"session_limit_behaviour":"PREVENT_LOGIN"},"key":"response","summary":"response","id":"paths/~1v3~1accounts~1{id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v4~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/response":{"value":{"company_id":"123456789ABCD","name":"Account name","number_of_seats":5,"allow_oversubscription":true,"notify_when_account_oversubscribed":true,"notify_on_each_registration_when_account_is_oversubscribed":true,"registration_code":"Registration code","on_premises_ips":"125.124.143.24","premises_tags":"[\"gold-tier\", \"university\"]","session_limit":10,"session_limit_behaviour":"PREVENT_LOGIN"},"key":"response","summary":"response","id":"paths/~1v4~1accounts~1{account_id}/get/responses/200/content/application~1json/examples/response"},"paths/~1v4~1accounts/get/responses/200/content/application~1json/examples/response":{"value":{"results":[{"company_id":"123456789ABCD","name":"Account name","number_of_seats":5,"allow_oversubscription":true,"notify_when_account_oversubscribed":true,"notify_on_each_registration_when_account_is_oversubscribed":true,"registration_code":"Registration code","on_premises_ips":"125.124.143.24","premises_tags":"[\"gold-tier\", \"university\"]","session_limit":10,"session_limit_behaviour":"PREVENT_LOGIN"}]},"key":"response","summary":"response","id":"paths/~1v4~1accounts/get/responses/200/content/application~1json/examples/response"},"paths/~1v4~1accounts~1{accountId}~1users/post/responses/202/content/application~1json/examples/response":{"value":"Bulk adding account users for account `accountId`","key":"response","summary":"response","id":"paths/~1v4~1accounts~1{accountId}~1users/post/responses/202/content/application~1json/examples/response"},"paths/~1v3~1request-rules~1{id}~1versions/post/responses/200/content/application~1json/examples/response":{"value":{"label":"Test","conditions":{"url_pattern":"^/forum","method":"POST"},"requirements_script":"return []","action_script":"return \"this is a test\"","script_type":"javascript","graph_state":"{\"property1\": \"value1\"}","editing_mode":"manual"},"key":"response","summary":"response","id":"paths/~1v3~1request-rules~1{id}~1versions/post/responses/200/content/application~1json/examples/response"},"paths/~1zephr~1public~1template-components~1v1~1template-components~1{templateConfigId}/get/responses/200/content/application~1json/examples/response":{"value":["The template the-value::!"],"key":"response","summary":"response","id":"paths/~1zephr~1public~1template-components~1v1~1template-components~1{templateConfigId}/get/responses/200/content/application~1json/examples/response"}},"securitySchemeStore":{"ZephrHmacHttp":{"id":"ZephrHmacHttp","type":"http","scheme":"ZEPHR-HMAC-*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to this API can be authenticated using an HMAC token signed with keys created in the admin console. For more information on signing requests with HMAC, see: https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair/ For more information on generating keys for this, see: https://docs.zuora.com/en/zephr/configuration--integrations/admin-user-settings/manage-key-pairs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheme name in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", includes the signing algorithm as the final part of the name. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZEPHR-HMAC-SHA-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"servers":[{"url":"https://{tenantId}.api.zephr.com","variables":{"tenantId":{"default":"demo","description":"Your tenant ID."}}}],"specType":"openapi"},"options":{"codeSamples":{"languages":[{"lang":"Payload","label":"Payload"},{"lang":"curl","label":"cURL"}]},"mockServer":{"url":"/_mock/zephr-api-reference/zephr-admin-api","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/zephr-api-reference/zephr-admin-api.json?download"},{"url":"/_bundle/zephr-api-reference/zephr-admin-api.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Admin API Reference","description":"\n\nThe Zephr Admin API provides RESTful access to all Zephr functionality. It is designed for server-side integrations. All requests must be signed as described in <a href=\"https://developer.zuora.com/zephr-docs/zephr-api/zephr-api-tutorials/hmac-request-signing-and-key-pair\" target=\"__blank\">HMAC Request Signing and Key Pairs</a>.\n\nThe Admin API uses a base URL with the following format: `https://{tenantId}.api.zephr.com`\n\n**Note**: If you have multiple tenants, the current tenant ID is shown in a blue box in the top right of the Admin Console.  If you have a single site, you can find the tenant ID by navigating to your site domains. To do this, select **Sites** from the **Delivery** menu, select your site, and then click the **Site Domains** button. The tenant ID is the first part of the domain. For example, if the domain is *news-paper.cdn.zephr.com*, the tenant ID is *news*.\n"}},"baseSlug":"/zephr-api-reference/zephr-admin-api","routesMapping":{}}