PUT /api/apis/versions/{APIVersionID}/viewers/{ViewerID}

Updates information about the specific licenses are available to the named ViewerID (group) for API access requests.

Corresponds to changes made in the following page of the Community Manager developer portal: API > Visibility > Groups > choose group > Edit Licenses.

Authorization Roles/Permissions: Must be logged in. Must have Modify permission for the API.

Metadata indexing: When this operation is run successfully, the platform metadata is automatically reindexed. Since the API documentation might include a metadata.xml file that directs visibility, the index must be updated when the API documentation resources are updated, to ensure the correct API documentation visibility settings are implemented.

This topic includes the following sections:

HTTP Method

PUT

URL

https://{hostname}/api/apis/versions/{APIVersionID}/viewers/{ViewerID}

Sample Request

The example below shows a request for the specified group to have visibility of the specified API version.

Sample Request URL

https://{hostname}/api/apis/versions/74ae5862-de41-4779-818e-a40b7bed0c68.rcoaless/viewers/cd519032-b0a3-47f8-9fb6-987e0d85432c.rcoaless

Sample request headers

Accept: application/json
Content-Type: application/json
AtmoAuthToken_rcoaless=TokenID%3D1edb9803-f56d-4a5a-b705-44acb77bd3e6%2Cclaimed_id%3Durn%3Aa...
X-Csrf-Token_rcoaless: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "ResourceID":"74ae5862-de41-4779-818e-a40b7bed0c68.rcoaless",
  "ViewerID":"cd519032-b0a3-47f8-9fb6-987e0d85432c.rcoaless",
  "ViewerType":"group",
  "RestrictedScope":"true",
  "LicenseID":[
    "652245c0-0b4f-4582-bfdc-0e3854565eeb.rcoaless",
    "08f2f183-d3d7-48b9-bd1d-8f5301eaf8ae.rcoaless"
  ]
}

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json or application/xml application/vnd.soa.v71+json or application/vnd.soa.v71+xml application/vnd.soa.v72+json or application/vnd.soa.v72+xml application/vnd.soa.v80+json or application/vnd.soa.v80+xml application/vnd.soa.v81+json or application/vnd.soa.v81+xml
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
APIVersionID	Path	string	Required	The unique ID for a specific API version.
ViewerID	Path	string	Required	The ID of the group that has visibility of the API.
VisibilityScope	Body	VisibilityContract	Required	Contains information about a visibility contract between a resource and a viewer. It includes the API version, the group that has visibility, and the visibility permissions—one or more specific licenses, or unlimited visibility.

Response

If successful, this operation returns HTTP status code 200, with information about the updated private viewer scope.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Expires: Wed, 12 May 2021 18:06:30 GMT

Sample response body: application/json

{
  "ResourceID":"74ae5862-de41-4779-818e-a40b7bed0c68.rcoaless",
  "ResourceType":"apiversion",
  "ViewerID":"cd519032-b0a3-47f8-9fb6-987e0d85432c.rcoaless",
  "ViewerType":"group",
  "RestrictedScope":true,
  "License":[
    {
      "LicenseID":"652245c0-0b4f-4582-bfdc-0e3854565eeb.rcoaless",
      "Name":"Silver",
      "Description":"Silver",
      "Visibility":"Public",
      "SandboxAccessAutoApproved":true,
      "ProductionAccessAutoApproved":false,
      "LicenseParts":{
        "LicensePart":[
          {
            "Name":"287594c4-8d47-488c-a6f4-9238a01321c5",
            "ResourceID":[
              "42b97e0a-322a-43c1-b335-969d6ec6ed39.rcoaless"
            ]
          }
        ]
      },
      "BusinessID":"tenantbusiness.rcoaless"
    },
    {
      "LicenseID":"08f2f183-d3d7-48b9-bd1d-8f5301eaf8ae.rcoaless",
      "Name":"Bronze",
      "Description":"Bronze",
      "Visibility":"Public",
      "SandboxAccessAutoApproved":true,
      "ProductionAccessAutoApproved":false,
      "LicenseParts":{
        "LicensePart":[
          {
            "Name":"5d8c46e5-b981-44cd-883a-a11790181651",
            "ResourceID":[
              "42b97e0a-322a-43c1-b335-969d6ec6ed39.rcoaless"
            ]
          }
        ]
      },
      "BusinessID":"tenantbusiness.rcoaless"
    }
  ]
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Response Body

Name	Type	Description
VisibilityContractDetails	VisibilityContractDetails	Contains information about a group's visibility of a specific resource.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics