{"payload":{"allShortcutsEnabled":false,"fileTree":{"":{"items":[{"name":".github","path":".github","contentType":"directory"},{"name":"tools","path":"tools","contentType":"directory"},{"name":".travis.yml","path":".travis.yml","contentType":"file"},{"name":"CONTRIBUTING.md","path":"CONTRIBUTING.md","contentType":"file"},{"name":"LICENSE","path":"LICENSE","contentType":"file"},{"name":"NOTICE","path":"NOTICE","contentType":"file"},{"name":"README.md","path":"README.md","contentType":"file"},{"name":"compatibility.md","path":"compatibility.md","contentType":"file"},{"name":"diagram.md","path":"diagram.md","contentType":"file"},{"name":"gettingStarted.md","path":"gettingStarted.md","contentType":"file"},{"name":"high_res_log.png","path":"high_res_log.png","contentType":"file"},{"name":"logo.png","path":"logo.png","contentType":"file"},{"name":"logo.svg","path":"logo.svg","contentType":"file"},{"name":"openapi.yaml","path":"openapi.yaml","contentType":"file"},{"name":"profile.md","path":"profile.md","contentType":"file"},{"name":"release-notes.md","path":"release-notes.md","contentType":"file"},{"name":"spec.md","path":"spec.md","contentType":"file"},{"name":"swagger.yaml","path":"swagger.yaml","contentType":"file"}],"totalCount":18}},"fileTreeProcessingTime":3.75754,"foldersToFetch":[],"repo":{"id":62855546,"defaultBranch":"master","name":"servicebroker","ownerLogin":"openservicebrokerapi","currentUserCanPush":false,"isFork":false,"isEmpty":false,"createdAt":"2016-07-08T03:22:26.000Z","ownerAvatar":"https://avatars.githubusercontent.com/u/19862012?v=4","public":true,"private":false,"isOrgOwned":true},"symbolsExpanded":false,"treeExpanded":true,"refInfo":{"name":"master","listCacheKey":"v0:1660072168.886137","canEdit":false,"refType":"branch","currentOid":"565c1d7c9f6f9edc4c68a673ef115d050921fcca"},"path":"profile.md","currentUser":null,"blob":{"rawLines":null,"stylingDirectives":null,"colorizedLines":null,"csv":null,"csvError":null,"dependabotInfo":{"showConfigurationBanner":false,"configFilePath":null,"networkDependabotPath":"/openservicebrokerapi/servicebroker/network/updates","dismissConfigurationNoticePath":"/settings/dismiss-notice/dependabot_configuration_notice","configurationNoticeDismissed":null},"displayName":"profile.md","displayUrl":"https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md?raw=true","headerInfo":{"blobSize":"23.8 KB","deleteTooltip":"You must be signed in to make or propose changes","editTooltip":"You must be signed in to make or propose changes","ghDesktopPath":"https://desktop.github.com","isGitLfs":false,"onBranch":true,"shortPath":"a430c09","siteNavLoginPath":"/login?return_to=https%3A%2F%2Fgithub.com%2Fopenservicebrokerapi%2Fservicebroker%2Fblob%2Fmaster%2Fprofile.md","isCSV":false,"isRichtext":true,"toc":[{"level":1,"text":"Open Service Broker API Profile (master - might contain changes that are not yet released)","anchor":"open-service-broker-api-profile-master---might-contain-changes-that-are-not-yet-released","htmlText":"Open Service Broker API Profile (master - might contain changes that are not yet released)"},{"level":2,"text":"Abstract","anchor":"abstract","htmlText":"Abstract"},{"level":2,"text":"Table of Contents","anchor":"table-of-contents","htmlText":"Table of Contents"},{"level":2,"text":"Notations and Terminology","anchor":"notations-and-terminology","htmlText":"Notations and Terminology"},{"level":3,"text":"Notational Conventions","anchor":"notational-conventions","htmlText":"Notational Conventions"},{"level":3,"text":"Terminology","anchor":"terminology","htmlText":"Terminology"},{"level":2,"text":"Originating Identity Header","anchor":"originating-identity-header","htmlText":"Originating Identity Header"},{"level":3,"text":"Cloud Foundry Originating Identity Header","anchor":"cloud-foundry-originating-identity-header","htmlText":"Cloud Foundry Originating Identity Header"},{"level":3,"text":"Kubernetes Originating Identity Header","anchor":"kubernetes-originating-identity-header","htmlText":"Kubernetes Originating Identity Header"},{"level":2,"text":"Context Object","anchor":"context-object","htmlText":"Context Object"},{"level":3,"text":"Context Object Properties","anchor":"context-object-properties","htmlText":"Context Object Properties"},{"level":3,"text":"Cloud Foundry Context Object","anchor":"cloud-foundry-context-object","htmlText":"Cloud Foundry Context Object"},{"level":3,"text":"Kubernetes Context Object","anchor":"kubernetes-context-object","htmlText":"Kubernetes Context Object"},{"level":2,"text":"Bind Resource Object","anchor":"bind-resource-object","htmlText":"Bind Resource Object"},{"level":3,"text":"Cloud Foundry Bind Resource Object","anchor":"cloud-foundry-bind-resource-object","htmlText":"Cloud Foundry Bind Resource Object"},{"level":2,"text":"Service Metadata","anchor":"service-metadata","htmlText":"Service Metadata"},{"level":4,"text":"Service Metadata Fields","anchor":"service-metadata-fields","htmlText":"Service Metadata Fields"},{"level":4,"text":"Plan Metadata Fields","anchor":"plan-metadata-fields","htmlText":"Plan Metadata Fields"},{"level":4,"text":"Cost Object","anchor":"cost-object","htmlText":"Cost Object"},{"level":4,"text":"Example Service Broker Response Body","anchor":"example-service-broker-response-body","htmlText":"Example Service Broker Response Body"},{"level":3,"text":"Cloud Foundry Service Metadata","anchor":"cloud-foundry-service-metadata","htmlText":"Cloud Foundry Service Metadata"},{"level":4,"text":"Service Metadata Fields","anchor":"service-metadata-fields-1","htmlText":"Service Metadata Fields"},{"level":2,"text":"Catalog Extensions","anchor":"catalog-extensions","htmlText":"Catalog Extensions"},{"level":4,"text":"Cloud Foundry Catalog Extensions","anchor":"cloud-foundry-catalog-extensions","htmlText":"Cloud Foundry Catalog Extensions"},{"level":5,"text":"Dashboard Client Object","anchor":"dashboard-client-object","htmlText":"Dashboard Client Object"},{"level":4,"text":"Example Catalog","anchor":"example-catalog","htmlText":"Example Catalog"}],"lineInfo":{"truncatedLoc":"672","truncatedSloc":"524"},"mode":"file"},"image":false,"isCodeownersFile":null,"isPlain":false,"isValidLegacyIssueTemplate":false,"issueTemplate":null,"discussionTemplate":null,"language":"Markdown","languageID":222,"large":false,"planSupportInfo":{"repoIsFork":null,"repoOwnedByCurrentUser":null,"requestFullPath":"/openservicebrokerapi/servicebroker/blob/master/profile.md","showFreeOrgGatedFeatureMessage":null,"showPlanSupportBanner":null,"upgradeDataAttributes":null,"upgradePath":null},"publishBannersInfo":{"dismissActionNoticePath":"/settings/dismiss-notice/publish_action_from_dockerfile","releasePath":"/openservicebrokerapi/servicebroker/releases/new?marketplace=true","showPublishActionBanner":false},"rawBlobUrl":"https://github.com/openservicebrokerapi/servicebroker/raw/master/profile.md","renderImageOrRaw":false,"richText":"

Open Service Broker API Profile (master - might contain changes that are not yet released)

\n

Abstract

\n

The Open Service Broker API specification allows for extensions\nand variations based on the environments in which it is being used; this\ndocument contains the suggested usage pattern for some of those variants.

\n

While use of this profile is OPTIONAL, an implementation is not compliant\nwith this profile if it fails to satisfy one or more of the MUST, SHALL\nor REQUIRED level requirements defined herein.

\n

Table of Contents

\n\n

Notations and Terminology

\n

Notational Conventions

\n

The key words \"MUST\", \"MUST NOT\", \"REQUIRED\", \"SHALL\", \"SHALL NOT\", \"SHOULD\",\n\"SHOULD NOT\", \"RECOMMENDED\", \"MAY\", and \"OPTIONAL\" in this document are to\nbe interpreted as described in RFC 2119.

\n

Terminology

\n

Please refer to terminology defined by the\nOpen Service Broker API specification.

\n

Originating Identity Header

\n

In the Open Service Broker API specification it defines an\nadditional HTTP Header that can be included in messages from the Platform\nto identify the user that requested the action to be taken.

\n

The header consists of two parts: a platform string and value string,\nwhere the value is a Base64 encoded serialized JSON object.\nBoth parts will vary based on the Platform which is being used. The\nfollowing sections define the values to be used based on the Platform\nand which properties are expected to appear in the value JSON.

\n

Note that when both the originating identity HTTP Header and the Context\nobject appear in the same message the platform value MUST be the same\nfor both.

\n

Cloud Foundry Originating Identity Header

\n

platform Value: cloudfoundry

\n

The following properties MUST appear within the JSON encoded value:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeDescription
user_idstringThe user_id value from the Cloud Foundry JWT token.
\n

Platforms MAY include additional properties.

\n

For example, a value of:

\n
{\n  \"user_id\": \"683ea748-3092-4ff4-b656-39cacc4d5360\"\n}
\n

would appear in the HTTP Header as:

\n
X-Broker-API-Originating-Identity: cloudfoundry eyANCiAgInVzZXJfaWQiOiAiNjgzZWE3NDgtMzA5Mi00ZmY0LWI2NTYtMzljYWNjNGQ1MzYwIg0KfQ==\n
\n

Kubernetes Originating Identity Header

\n

platform Value: kubernetes

\n

The following properties MUST appear within the JSON encoded value:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeDescription
usernamestringThe username property from the Kubenernetes user.info object.
uidstringThe uid property from the Kubenernetes user.info object.
groupsarray-of-stringsThe groups property from the Kubenernetes user.info object.
extramap-of-array-of-stringsThe extra property from the Kubernetes user.info object.
\n

Platforms MAY include additional properties.

\n

For example, a value of:

\n
{\n  \"username\": \"duke\",\n  \"uid\": \"c2dde242-5ce4-11e7-988c-000c2946f14f\",\n  \"groups\": [ \"admin\", \"dev\" ],\n  \"extra\": {\n    \"mydata\": [ \"data1\", \"data3\" ]\n  }\n}
\n

would appear in the HTTP Header as:

\n
X-Broker-API-Originating-Identity: kubernetes ew0KICAidXNlcm5hbWUiOiAiZHVrZSIsDQogICJ1aWQiOiAiYzJkZGUyNDItNWNlNC0xMWU3LTk4OGMtMDAwYzI5NDZmMTRmIiwNCiAgImdyb3VwcyI6IFsgImFkbWluIiwgImRldiIgXSwNCiAgImV4dHJhIjogew0KICAgICJteWRhdGEiOiBbICJkYXRhMSIsICJkYXRhMyIgXQ0KICB9DQp9\n
\n

Context Object

\n

In the Open Service Broker API specification there are certain\nmessage flows that include a context property. This property is defined\nas an opaque JSON object that is meant to contain contextual information\nabout the environment in which the Platform or Application is executing.

\n

While the context property is defined as an opaque JSON object, in practice,\nit is often useful and necessary for there to be an agreed upon set of\nproperties to ensure a common understanding of this data between the\nPlatform and the Service Brokers.

\n

Context Object Properties

\n

The list of properties within the Context Object can vary depending on\nwhich Service Broker API is being invoked and which Platform is being used.\nThis section will define a set of properties for each Platform and specify\nwhen each is meant to be used. Platforms MAY choose to provide additional\nproperties beyond the ones defined in this document.

\n

Each property will include the version of the Open Service Broker\nAPI in which it was introduced. For any API call in which that property\nis mandatory, it is only mandatory for the specified version of the\nspecification or higher.

\n

Aside from the Platform specific properties, defined in the following\nsections, there is one common property called platform that\nMUST also appear within context to indicate which Platform is being used.

\n

The platform property MUST be a string and serialized as follows:

\n
\"platform\": \"platform-string-here\"\n
\n

Each section below will define the platform value that MUST be used based\non the Platform and the set of additional properties that MUST be present.

\n

Note that when both the originating identity HTTP Header and the Context\nobject appear in the same message the platform value MUST be the same\nfor both.

\n

To enable support for Platforms to send an update request for a Service Instance\ncontaining only contextual data, a Service Broker MUST declare support by\nincluding \"allow_context_updates\": true in its\ncatalog endpoint.

\n

Cloud Foundry Context Object

\n

platform Property Value: cloudfoundry

\n

The following properties are defined for usage within a Cloud Foundry\ndeployment:

\n\n

The following table specifies which properties will appear in each API.\nAll properties specified are REQUIRED unless otherwise noted.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Request APIProperties
PUT /v2/service_instances/:instance_idorganization_guid, organization_name, space_guid, space_name, instance_name
PATCH /v2/service_instances/:instance_idorganization_guid, organization_name, space_guid, space_name, instance_name
PUT /v2/service_instances/:instance_id/service_bindings/:binding_idorganization_guid, organization_name, space_guid, space_name
\n

The following example shows a context object that might appear as part of a\nCloud Foundry API call:

\n
\"context\": {\n  \"platform\": \"cloudfoundry\",\n  \"organization_guid\": \"1113aa0-124e-4af2-1526-6bfacf61b111\",\n  \"organization_name\": \"system\",\n  \"space_guid\": \"aaaa1234-da91-4f12-8ffa-b51d0336aaaa\",\n  \"space_name\": \"development\",\n  \"instance_name\": \"my-db\"\n}\n
\n\n

Kubernetes Context Object

\n

platform Property Value: kubernetes

\n

The following properties are defined for usage within a Kubernetes deployment:

\n\n

The following table specifies which properties will appear in each API.\nAll properties specified are REQUIRED unless otherwise noted.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Request APIProperties
PUT /v2/service_instances/:instance_idnamespace, clusterid, instance_name
PATCH /v2/service_instances/:instance_idnamespace, clusterid, instance_name
PUT /v2/service_instances/:instance_id/service_bindings/:binding_idnamespace, clusterid
\n

Example:

\n

The following example shows a context property that might appear as\npart of a Kubernetes API call:

\n
\"context\": {\n  \"platform\": \"kubernetes\",\n  \"namespace\": \"development\",\n  \"clusterid\": \"8263feba-9b8a-23ae-99ed-abcd1234feda\"\n}\n
\n

Bind Resource Object

\n

In the Open Service Broker API specification, requests to\ncreate a Service Binding can contain a bind_resource\nobject in which Platforms MAY choose to add additional fields.

\n

Cloud Foundry Bind Resource Object

\n

The Cloud Foundry Bind Resource Object supports the Cloud Foundry Service Binding and the Service Key developer requests. The credentials returned by the Service Binding endpoints MAY be references to credentials stored in CredHub, the component designed for centralized credential management in Cloud Foundry. Service Brokers are then responsible for writing credentials into CredHub and granting read permissions to a bound application or a specified client. See more details into Credhub documentation. The provisioning of CredHub access for Service Brokers is performed out of band and is out of scope of this specification.

\n

The following properties are defined for usage within a Cloud Foundry\ndeployment:

\n\n

The following example shows a bind_resource object that might appear as part\nof a Cloud Foundry API call resulting from a Service Binding developer request:

\n
\"bind_resource\": {\n  \"app_guid\": \"5e76c9bf-d5e3-46bf-9877-6d8dddfc8a45\",\n  \"space_guid\": \"15823972-c216-4ba5-9f3f-e75b0b891297\"\n}\n
\n

The following example shows a bind_resource object that might appear as part\nof a Cloud Foundry API call resulting from a Service Key developer request:

\n
\"bind_resource\": {\n  \"credential_client_id\": \"cc_service_key_client\"\n}\n
\n

Service Metadata

\n

While the specification does not mandate the property names used\nin the metadata objects, it is RECOMMENDED that the following names\nbe used when possible in an attempt to provide some degree of interoperability\nand consistency.

\n

Please note that in addition to service metadata returned from catalog endpoint,\nService Brokers MAY also expose service-instance-specific metadata through the\nServiceInstanceMetadata structure returned by Service Brokers\nin the Provisioning endpoint with updates potentially published\nin the Updating and Fetching a Service Instance endpoints.

\n

Service Metadata Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Service Broker API FieldTypeDescription
metadata.displayNamestringThe name of the service to be displayed in graphical clients.
metadata.imageUrlstringThe URL to an image or a data URL containing an image.
metadata.longDescriptionstringLong description.
metadata.providerDisplayNamestringThe name of the upstream entity providing the actual service.
metadata.documentationUrlstringLink to documentation page for the service.
metadata.supportUrlstringLink to support page for the service.
\n

Plan Metadata Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Service Broker API FieldTypeDescription
metadata.bulletsarray-of-stringsFeatures of this plan, to be displayed in a bulleted-list.
metadata.costsarray-of-objectsAn array-of-objects that describes the costs of a service, in what currency, and the unit of measure. If there are multiple costs, all of them could be billed to the user (such as a monthly + usage costs at once).
metadata.displayNamestringName of the plan to be displayed to clients.
\n

Cost Object

\n

This object describes the costs of a service, in what currency, and the unit\nof measure.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
amount*objectAn array of pricing in various currencies for the cost type as key-value pairs where key is currency code and value (as a float) is currency amount.
unit*stringDisplay name for type of cost, e.g. Monthly, Hourly, Request, GB.
\n

* Fields with an asterisk are REQUIRED.

\n

For example:

\n
\"costs\": [\n  {\n    \"amount\": {\n      \"usd\": 649.0\n    },\n    \"unit\": \"MONTHLY\"\n  }\n]\n
\n

Example Service Broker Response Body

\n

The example below contains a catalog of one service, having one Service Plan.\nOf course, a Service Broker can offer a catalog of many services, each having\nmany plans.

\n
{\n  \"services\":[\n    {\n      \"id\":\"766fa866-a950-4b12-adff-c11fa4cf8fdc\",\n      \"name\":\"cloudamqp\",\n      \"description\":\"Managed HA RabbitMQ servers in the cloud.\",\n      \"requires\":[],\n      \"tags\":[\n        \"amqp\",\n        \"rabbitmq\",\n        \"messaging\"\n      ],\n      \"metadata\":{\n        \"displayName\":\"CloudAMQP\",\n        \"imageUrl\":\"https://d33na3ni6eqf5j.cloudfront.net/app_resources/18492/thumbs_112/img9069612145282015279.png\",\n        \"longDescription\":\"Managed, highly available, RabbitMQ clusters in the cloud.\",\n        \"providerDisplayName\":\"84codes AB\",\n        \"documentationUrl\":\"http://docs.cloudfoundry.com/docs/dotcom/marketplace/services/cloudamqp.html\",\n        \"supportUrl\":\"http://www.cloudamqp.com/support.html\"\n      },\n      \"dashboard_client\":{\n        \"id\":\"p-mysql-client\",\n        \"secret\":\"p-mysql-secret\",\n        \"redirect_uri\":\"http://p-mysql.example.com/auth/create\"\n      },\n      \"plans\":[\n        {\n          \"id\":\"024f3452-67f8-40bc-a724-a20c4ea24b1c\",\n          \"name\":\"bunny\",\n          \"description\":\"A mid-sided plan.\",\n          \"metadata\":{\n            \"bullets\":[\n              \"20 GB of messages\",\n              \"20 connections\"\n            ],\n            \"costs\":[\n              {\n                \"amount\":{\n                  \"usd\":99.0\n                },\n                \"unit\":\"MONTHLY\"\n              },\n              {\n                \"amount\":{\n                  \"usd\":0.99\n                },\n                \"unit\":\"1GB of messages over 20GB\"\n              }\n            ],\n            \"displayName\":\"Big Bunny\"\n          }\n        }\n      ]\n    }\n  ]\n}
\n

Cloud Foundry Service Metadata

\n

In addition to the metadata described in Service Metadata,\nService Brokers MAY also expose the following fields to enable Cloud Foundry\nspecific behaviour.

\n

Service Metadata Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Broker API FieldTypeDescription
metadata.shareablebooleanAllows Service Instances to be shared across orgs and spaces.
\n

Catalog Extensions

\n

In addition to the fields described in the Catalog,\nService Brokers MAY also expose the following fields to enable Platform specific behaviour.

\n

Cloud Foundry Catalog Extensions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
services[n].dashboard_clientDashboardClientContains the data necessary to activate the Dashboard SSO feature for this service.
\n
Dashboard Client Object
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response FieldTypeDescription
id*stringThe id of the OAuth client that the dashboard will use. If present, MUST be a non-empty string.
secret*stringA secret for the dashboard client. If present, MUST be a non-empty string.
redirect_uristringA URI for the service dashboard. Validated by the OAuth token server when the dashboard requests a token.
\n

* Fields with an asterisk are REQUIRED.

\n

Example Catalog

\n
{\n  \"services\": [{\n    \"name\": \"fake-service\",\n    \"id\": \"acb56d7c-XXXX-XXXX-XXXX-feb140a59a66\",\n    \"description\": \"A fake service.\",\n    \"dashboard_client\": {\n      \"id\": \"398e2f8e-XXXX-XXXX-XXXX-19a71ecbcf64\",\n      \"secret\": \"277cabb0-XXXX-XXXX-XXXX-7822c0a90e5d\",\n      \"redirect_uri\": \"http://localhost:1234\"\n    }\n  }]\n}\n
\n
","renderedFileInfo":null,"shortPath":null,"symbolsEnabled":true,"tabSize":8,"topBannersInfo":{"overridingGlobalFundingFile":false,"globalPreferredFundingPath":null,"showInvalidCitationWarning":false,"citationHelpUrl":"https://docs.github.com/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files","actionsOnboardingTip":null},"truncated":false,"viewable":true,"workflowRedirectUrl":null,"symbols":{"timed_out":false,"not_analyzed":false,"symbols":[{"name":"Open Service Broker API Profile (master - might contain changes that are not yet released)","kind":"section_1","ident_start":2,"ident_end":92,"extent_start":0,"extent_end":24412,"fully_qualified_name":"Open Service Broker API Profile (master - might contain changes that are not yet released)","ident_utf16":{"start":{"line_number":0,"utf16_col":2},"end":{"line_number":0,"utf16_col":92}},"extent_utf16":{"start":{"line_number":0,"utf16_col":0},"end":{"line_number":672,"utf16_col":0}}},{"name":"Abstract","kind":"section_2","ident_start":97,"ident_end":105,"extent_start":94,"extent_end":524,"fully_qualified_name":"Abstract","ident_utf16":{"start":{"line_number":2,"utf16_col":3},"end":{"line_number":2,"utf16_col":11}},"extent_utf16":{"start":{"line_number":2,"utf16_col":0},"end":{"line_number":12,"utf16_col":0}}},{"name":"Table of Contents","kind":"section_2","ident_start":527,"ident_end":544,"extent_start":524,"extent_end":1507,"fully_qualified_name":"Table of Contents","ident_utf16":{"start":{"line_number":12,"utf16_col":3},"end":{"line_number":12,"utf16_col":20}},"extent_utf16":{"start":{"line_number":12,"utf16_col":0},"end":{"line_number":31,"utf16_col":0}}},{"name":"Notations and Terminology","kind":"section_2","ident_start":1510,"ident_end":1535,"extent_start":1507,"extent_end":1924,"fully_qualified_name":"Notations and Terminology","ident_utf16":{"start":{"line_number":31,"utf16_col":3},"end":{"line_number":31,"utf16_col":28}},"extent_utf16":{"start":{"line_number":31,"utf16_col":0},"end":{"line_number":44,"utf16_col":0}}},{"name":"Notational Conventions","kind":"section_3","ident_start":1541,"ident_end":1563,"extent_start":1537,"extent_end":1801,"fully_qualified_name":"Notational Conventions","ident_utf16":{"start":{"line_number":33,"utf16_col":4},"end":{"line_number":33,"utf16_col":26}},"extent_utf16":{"start":{"line_number":33,"utf16_col":0},"end":{"line_number":39,"utf16_col":0}}},{"name":"Terminology","kind":"section_3","ident_start":1805,"ident_end":1816,"extent_start":1801,"extent_end":1924,"fully_qualified_name":"Terminology","ident_utf16":{"start":{"line_number":39,"utf16_col":4},"end":{"line_number":39,"utf16_col":15}},"extent_utf16":{"start":{"line_number":39,"utf16_col":0},"end":{"line_number":44,"utf16_col":0}}},{"name":"Originating Identity Header","kind":"section_2","ident_start":1927,"ident_end":1954,"extent_start":1924,"extent_end":4384,"fully_qualified_name":"Originating Identity Header","ident_utf16":{"start":{"line_number":44,"utf16_col":3},"end":{"line_number":44,"utf16_col":30}},"extent_utf16":{"start":{"line_number":44,"utf16_col":0},"end":{"line_number":115,"utf16_col":0}}},{"name":"Cloud Foundry Originating Identity Header","kind":"section_3","ident_start":2661,"ident_end":2702,"extent_start":2657,"extent_end":3258,"fully_qualified_name":"Cloud Foundry Originating Identity Header","ident_utf16":{"start":{"line_number":60,"utf16_col":4},"end":{"line_number":60,"utf16_col":45}},"extent_utf16":{"start":{"line_number":60,"utf16_col":0},"end":{"line_number":83,"utf16_col":0}}},{"name":"Kubernetes Originating Identity Header","kind":"section_3","ident_start":3262,"ident_end":3300,"extent_start":3258,"extent_end":4384,"fully_qualified_name":"Kubernetes Originating Identity Header","ident_utf16":{"start":{"line_number":83,"utf16_col":4},"end":{"line_number":83,"utf16_col":42}},"extent_utf16":{"start":{"line_number":83,"utf16_col":0},"end":{"line_number":115,"utf16_col":0}}},{"name":"Context Object","kind":"section_2","ident_start":4387,"ident_end":4401,"extent_start":4384,"extent_end":14585,"fully_qualified_name":"Context Object","ident_utf16":{"start":{"line_number":115,"utf16_col":3},"end":{"line_number":115,"utf16_col":17}},"extent_utf16":{"start":{"line_number":115,"utf16_col":0},"end":{"line_number":430,"utf16_col":0}}},{"name":"Context Object Properties","kind":"section_3","ident_start":4956,"ident_end":4981,"extent_start":4952,"extent_end":6449,"fully_qualified_name":"Context Object Properties","ident_utf16":{"start":{"line_number":127,"utf16_col":4},"end":{"line_number":127,"utf16_col":29}},"extent_utf16":{"start":{"line_number":127,"utf16_col":0},"end":{"line_number":161,"utf16_col":0}}},{"name":"Cloud Foundry Context Object","kind":"section_3","ident_start":6453,"ident_end":6481,"extent_start":6449,"extent_end":11153,"fully_qualified_name":"Cloud Foundry Context Object","ident_utf16":{"start":{"line_number":161,"utf16_col":4},"end":{"line_number":161,"utf16_col":32}},"extent_utf16":{"start":{"line_number":161,"utf16_col":0},"end":{"line_number":314,"utf16_col":0}}},{"name":"Kubernetes Context Object","kind":"section_3","ident_start":11157,"ident_end":11182,"extent_start":11153,"extent_end":14585,"fully_qualified_name":"Kubernetes Context Object","ident_utf16":{"start":{"line_number":314,"utf16_col":4},"end":{"line_number":314,"utf16_col":29}},"extent_utf16":{"start":{"line_number":314,"utf16_col":0},"end":{"line_number":430,"utf16_col":0}}},{"name":"Bind Resource Object","kind":"section_2","ident_start":14588,"ident_end":14608,"extent_start":14585,"extent_end":18389,"fully_qualified_name":"Bind Resource Object","ident_utf16":{"start":{"line_number":430,"utf16_col":3},"end":{"line_number":430,"utf16_col":23}},"extent_utf16":{"start":{"line_number":430,"utf16_col":0},"end":{"line_number":503,"utf16_col":0}}},{"name":"Cloud Foundry Bind Resource Object","kind":"section_3","ident_start":14821,"ident_end":14855,"extent_start":14817,"extent_end":18389,"fully_qualified_name":"Cloud Foundry Bind Resource Object","ident_utf16":{"start":{"line_number":436,"utf16_col":4},"end":{"line_number":436,"utf16_col":38}},"extent_utf16":{"start":{"line_number":436,"utf16_col":0},"end":{"line_number":503,"utf16_col":0}}},{"name":"Service Metadata","kind":"section_2","ident_start":18392,"ident_end":18408,"extent_start":18389,"extent_end":23119,"fully_qualified_name":"Service Metadata","ident_utf16":{"start":{"line_number":503,"utf16_col":3},"end":{"line_number":503,"utf16_col":19}},"extent_utf16":{"start":{"line_number":503,"utf16_col":0},"end":{"line_number":635,"utf16_col":0}}},{"name":"Service Metadata Fields","kind":"section_4","ident_start":19176,"ident_end":19199,"extent_start":19171,"extent_end":19780,"fully_qualified_name":"Service Metadata Fields","ident_utf16":{"start":{"line_number":516,"utf16_col":5},"end":{"line_number":516,"utf16_col":28}},"extent_utf16":{"start":{"line_number":516,"utf16_col":0},"end":{"line_number":527,"utf16_col":0}}},{"name":"Plan Metadata Fields","kind":"section_4","ident_start":19785,"ident_end":19805,"extent_start":19780,"extent_end":20313,"fully_qualified_name":"Plan Metadata Fields","ident_utf16":{"start":{"line_number":527,"utf16_col":5},"end":{"line_number":527,"utf16_col":25}},"extent_utf16":{"start":{"line_number":527,"utf16_col":0},"end":{"line_number":534,"utf16_col":0}}},{"name":"Cost Object","kind":"section_4","ident_start":20318,"ident_end":20329,"extent_start":20313,"extent_end":20880,"fully_qualified_name":"Cost Object","ident_utf16":{"start":{"line_number":534,"utf16_col":5},"end":{"line_number":534,"utf16_col":16}},"extent_utf16":{"start":{"line_number":534,"utf16_col":0},"end":{"line_number":557,"utf16_col":0}}},{"name":"Example Service Broker Response Body","kind":"section_4","ident_start":20885,"ident_end":20921,"extent_start":20880,"extent_end":22714,"fully_qualified_name":"Example Service Broker Response Body","ident_utf16":{"start":{"line_number":557,"utf16_col":5},"end":{"line_number":557,"utf16_col":41}},"extent_utf16":{"start":{"line_number":557,"utf16_col":0},"end":{"line_number":622,"utf16_col":0}}},{"name":"Cloud Foundry Service Metadata","kind":"section_3","ident_start":22718,"ident_end":22748,"extent_start":22714,"extent_end":23119,"fully_qualified_name":"Cloud Foundry Service Metadata","ident_utf16":{"start":{"line_number":622,"utf16_col":4},"end":{"line_number":622,"utf16_col":34}},"extent_utf16":{"start":{"line_number":622,"utf16_col":0},"end":{"line_number":635,"utf16_col":0}}},{"name":"Service Metadata Fields","kind":"section_4","ident_start":22934,"ident_end":22957,"extent_start":22929,"extent_end":23119,"fully_qualified_name":"Service Metadata Fields","ident_utf16":{"start":{"line_number":629,"utf16_col":5},"end":{"line_number":629,"utf16_col":28}},"extent_utf16":{"start":{"line_number":629,"utf16_col":0},"end":{"line_number":635,"utf16_col":0}}},{"name":"Catalog Extensions","kind":"section_2","ident_start":23122,"ident_end":23140,"extent_start":23119,"extent_end":24412,"fully_qualified_name":"Catalog Extensions","ident_utf16":{"start":{"line_number":635,"utf16_col":3},"end":{"line_number":635,"utf16_col":21}},"extent_utf16":{"start":{"line_number":635,"utf16_col":0},"end":{"line_number":672,"utf16_col":0}}},{"name":"Cloud Foundry Catalog Extensions","kind":"section_4","ident_start":23322,"ident_end":23354,"extent_start":23317,"extent_end":24054,"fully_qualified_name":"Cloud Foundry Catalog Extensions","ident_utf16":{"start":{"line_number":640,"utf16_col":5},"end":{"line_number":640,"utf16_col":37}},"extent_utf16":{"start":{"line_number":640,"utf16_col":0},"end":{"line_number":656,"utf16_col":0}}},{"name":"Dashboard Client Object","kind":"section_5","ident_start":23579,"ident_end":23602,"extent_start":23573,"extent_end":24054,"fully_qualified_name":"Dashboard Client Object","ident_utf16":{"start":{"line_number":646,"utf16_col":6},"end":{"line_number":646,"utf16_col":29}},"extent_utf16":{"start":{"line_number":646,"utf16_col":0},"end":{"line_number":656,"utf16_col":0}}},{"name":"Example Catalog","kind":"section_4","ident_start":24059,"ident_end":24074,"extent_start":24054,"extent_end":24412,"fully_qualified_name":"Example Catalog","ident_utf16":{"start":{"line_number":656,"utf16_col":5},"end":{"line_number":656,"utf16_col":20}},"extent_utf16":{"start":{"line_number":656,"utf16_col":0},"end":{"line_number":672,"utf16_col":0}}}]}},"copilotInfo":null,"copilotAccessAllowed":false,"csrf_tokens":{"/openservicebrokerapi/servicebroker/branches":{"post":"4usTDJmbvYVviZghe6do7D9Pqji6Q7cBnfpTHh7CMslqvjtbE-pVhDCNCsQc-aWAo47a5qrTArFh2w_PGW0isg"},"/repos/preferences":{"post":"p1ye52ZZ739o01YLQjk30D4BzQ2YSNeaWL1xrrcAhzqJs7LFO0UKRh16zuWky5kjaDAL12YkQkSomhHhMHFttw"}}},"title":"servicebroker/profile.md at master ยท openservicebrokerapi/servicebroker"}