Get Markings User

GET/api/v2/admin/users/{userId}/getMarkings

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Retrieve Markings that the user is currently a member of.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-read.

Path parameters

userId

string

The ID of a Foundry Group or User.

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Response body

GetUserMarkingsResponse

object

Hide child attributes

view

list<MarkingId>

optional

The markings that the user has access to. The user will be able to access resources protected with these markings. This includes organization markings for organizations in which the user is a guest member.

Show child attributes

Examples

Request

Copied!

curl \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/admin/users/f05f8da4-b84c-4fca-9c77-8af0b13d11de/getMarkings?preview=true"

Response

Copied!

{
  "view": [
    "18212f9a-0e63-4b79-96a0-aae04df23336"
  ]
}

Error responses

Error Name
`GetMarkingsUserPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not getMarkings the User.
	Parameters	`userId`

See Errors for a general overview of errors in the platform.