GuidesAPI Reference
API Reference

Update the linkability of a resource

Update the linkability of this resource against the requested project or realm.


Access Control:

  • The calling principal must have permission to take all the "requiredToMakeLinkable" actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource.
  • This API works only with tokens that are scoped to the home project of the resource.
  • This API does not support the resources of type "pipeline".
Path Params
string
required

The hrn that identifies the resource.

string
required

The HRN of the project that the resource is made linkable to or the HRN of the realm that the resource is made linkable to. This property can be used for cross-realm sharing only if cross-realm trust is established. If there is no cross-realm trust established, the linkableToHrn value must be either a project in the same realm as the resource's home project, or must be the resource's home project's realm.

Body Params
string
required

The hrn of the resource

string

The hrn of the project that the resource is made linkable to

string

The hrn of the project that the resource is made linkable to

allowedActions
array of strings
required

The list of actions made available for referencing for the resourceType. These actions must be one of the "projectLinkingEnabled" actions of the service inferred via the reserved resource prefix of the resource in the path.

allowedActions*
Headers
string

Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated.

Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json