Home
Version 3
ServiceAuthTokens (deprecated) API

ServiceAuthTokens (deprecated) API

Filtering the result set by provider (deprecated)

GET /v2/service_auth_tokens

Fields

Name Description Default Valid Values Example Values
guid The guid of the service auth token.
label Human readable name for the auth token
  • Nic-Token
provider Human readable name of service provider
  • Face-Offer
token The secret auth token used for authenticating

Parameters

Name Description Valid Values Example Values
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: label, provider
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
page Page of results to fetch
results-per-page Number of results per page
order-direction Order of the results: asc (default) or desc
inline-relations-depth 0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
orphan-relations 0 - de-duplicate object entries in response
exclude-relations comma-delimited list of relations to drop from response
include-relations comma-delimited list of the only relations to include in response

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1MiIsImVtYWlsIjoiZW1haWwtMjU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5Nzl9.TSaulNwMFswIJldmy49sHNoRIwNXFQDhZ6RARbTjCXA
Host: example.org
Cookie: 

Route

GET /v2/service_auth_tokens

Query Parameters

q: provider:Face-Offer

cURL

curl "https://api.[your-domain.com]/v2/service_auth_tokens" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1MiIsImVtYWlsIjoiZW1haWwtMjU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5Nzl9.TSaulNwMFswIJldmy49sHNoRIwNXFQDhZ6RARbTjCXA" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 37b2e68a-1963-401b-998b-a8c2121f7fcf
X-Cf-Warnings: Support+for+the+v1+Service+Broker+API+is+deprecated+and+will+be+removed+in+the+next+major+version+of+Cloud+Foundry.+Consider+upgrading+your+broker+to+implement+the+v2+Service+Broker+API.
Content-Length: 448
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "706ab84e-fe23-4b6d-bc32-6614d1e1719a",
        "url": "/v2/service_auth_tokens/706ab84e-fe23-4b6d-bc32-6614d1e1719a",
        "created_at": "2014-12-24T01:39:39+00:00",
        "updated_at": null
      },
      "entity": {
        "label": "label-57",
        "provider": "Face-Offer"
      }
    }
  ]
}