UpdateListing

PATCH/api/v1/listings/{listing}

Update the definition of a listing. This includes the description, owner, and visibility.

Example request

US
Europe

curl -X PATCH \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{ "displayName": "string", "visibility": "UNLISTED" }' \
  "https://us.oblique.security/api/v1/listings/{listing}?updateMask=displayName,visibility"

Set OBLIQUE_API_KEY to your API key.

curl -X PATCH \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{ "displayName": "string", "visibility": "UNLISTED" }' \
  "https://eu.oblique.security/api/v1/listings/{listing}?updateMask=displayName,visibility"

Set OBLIQUE_API_KEY to your API key.

Path parameters

listing.namestringrequired
Assigned by Oblique. Name of the listing of the format listings/{id}.

Query parameters

updateMaskstring (field-mask)
The list of fields to update.
allowMissingboolean
If set to true, and the listing is not found, a new listing will be created with the given name. If created in this way, update_mask is ignored.

Request body

createTimestring (date-time)read-only
Create and update timestamps.
updateTimestring (date-time)read-only
deleteTimestring (date-time)read-only
If present, the listing has been deleted and won’t be returned in List operations.
effectiveMembersUpdateTimestring (date-time)read-only
The time when a change was last made that would require the listing’s effective members to be recomputed. For example, when an entitlement is created or deleted on a resource that is part of a listing role.
effectiveMembersSyncTimestring (date-time)read-only
The time when the listing’s effective members were last recomputed by the effective membership sync.
displayNamestringrequired
A short display name of the listing. For example “GitHub” or “Salesforce”.
descriptionstring
A longer description of the role explaining to the end user what this listing represents, or what users should do once they have access.
visibilitystringrequired
Allowed values: UNLISTED, PUBLIC
Visibility of the listing. When initially created, this should be set to “UNLISTED”.
managementManagement
How this listing is managed. Set automatically by the server based on the calling client. Omitted from responses when the listing is manually managed (the default).
- managerstring
  Allowed values: TERRAFORM
  How the resource is managed. Set automatically by the server based on the caller: Terraform clients produce TERRAFORM; for all other clients the management field is left unset on the response.
- repoUristring
  URI of the VCS repository that holds the Terraform configuration for this resource. Populated by the Oblique Terraform provider.
- repoDirstring
  Optionally, the subdirectory within repo_uri that holds the Terraform configuration for this resource. Populated by the Oblique Terraform provider.

Response

200Listing

Listing is a collection of resources by role that enable a user-facing view to facilitate access requests. Top level listings describe a service, such as “GitHub”, “Salesforce”, or “Datadog”. Listings then have a set of roles that grant users kinds of access to the service, such as “Viewer”, “Editor”, or “Admin”.

namestring
Assigned by Oblique. Name of the listing of the format listings/{id}.
createTimestring (date-time)read-only
Create and update timestamps.
updateTimestring (date-time)read-only
deleteTimestring (date-time)read-only
If present, the listing has been deleted and won’t be returned in List operations.
effectiveMembersUpdateTimestring (date-time)read-only
The time when a change was last made that would require the listing’s effective members to be recomputed. For example, when an entitlement is created or deleted on a resource that is part of a listing role.
effectiveMembersSyncTimestring (date-time)read-only
The time when the listing’s effective members were last recomputed by the effective membership sync.
displayNamestringrequired
A short display name of the listing. For example “GitHub” or “Salesforce”.
descriptionstring
A longer description of the role explaining to the end user what this listing represents, or what users should do once they have access.
visibilitystringrequired
Allowed values: UNLISTED, PUBLIC
Visibility of the listing. When initially created, this should be set to “UNLISTED”.
managementManagement
How this listing is managed. Set automatically by the server based on the calling client. Omitted from responses when the listing is manually managed (the default).
- managerstring
  Allowed values: TERRAFORM
  How the resource is managed. Set automatically by the server based on the caller: Terraform clients produce TERRAFORM; for all other clients the management field is left unset on the response.
- repoUristring
  URI of the VCS repository that holds the Terraform configuration for this resource. Populated by the Oblique Terraform provider.
- repoDirstring
  Optionally, the subdirectory within repo_uri that holds the Terraform configuration for this resource. Populated by the Oblique Terraform provider.

Errors

Status	Meaning
`400`	Malformed request
`401`	Missing or invalid API key
`403`	Not allowed for this API key
`404`	Not found
`429`	Too many requests
`500`	Internal server error