Permissions

The Permissions API provides functionality for obtaining a list permissions on the target site.


Basic information

Endpoints

TARGET_RESOURCE_URI — URI is obtained from the "sites/" or the "contacts/" endpoint.

Prefix Endpoint Description
TARGET_RESOURCE_URI permissions/ Getting permissions for the current user

+Getting permissions for the current user

Endpoint

  • TARGET_RESOURCE_URIpermissions/

Scopes

  • No specific scopes

Request

  • No specific request params

Response


Definitions

PermissionsResponse

Name Description

access
boolean

true if allowed.

entries
object

@PermissionsEntries

photos
object

@PermissionsPhotos

pages
object

@PermissionsPages

vbook
object

@PermissionsVbook

forums
object

@PermissionsForums
For the community site type.

awards
boolean

true if allowed.
For the profile site type.

gifts
boolean

true if allowed.
For the profile site type.

contacts
boolean

true if allowed.
For the profile site type.

sites
boolean

true if allowed.
For the profile site type.

members
boolean

true if allowed.
For the community site type.

PermissionsEntries

Name Description

add
boolean

true if allowed.

edit
boolean

true if allowed.

comment
boolean

true if allowed.

manage_categories
boolean

true if allowed.

with_premoderation
boolean

true if premoderation is required.

PermissionsPhotos

Name Description

add
boolean

true if allowed.

edit
boolean

true if allowed.

comment
boolean

true if allowed.

tag
boolean

true if allowed.

manage_categories
boolean

true if allowed.

with_premoderation
boolean

true if premoderation is required.

PermissionsPages

Name Description

add
boolean

true if allowed.

edit
boolean

true if allowed.

comment
boolean

true if allowed.

PermissionsVbook

Name Description

add
boolean

true if allowed.

edit
boolean

true if allowed.

reply
boolean

true if allowed.

with_premoderation
boolean

true if premoderation is required.

PermissionsForums

Name Description

add_forums
boolean

true if allowed.

edit_forums
boolean

true if allowed.

delete_forums
boolean

true if allowed.

add_threads
boolean

true if allowed.

edit_threads
boolean

true if allowed.

delete_threads
boolean

true if allowed.

add_posts
boolean

true if allowed.

edit_posts
boolean

true if allowed.

delete_posts
boolean

true if allowed.