GET api.ashx/v2/{application}/{id}/roles.{json|xml}
LIST roles for an application.
Scopes
Security(Roles and Permissions) › Read Roles security.roles.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Application | string | Application | Required | |||
Id | int? | Id | Optional | |||
Include | string | Options for include are user, granted, or denied. Ex: include=granted. | Optional | |||
IncludePermissions | bool | Include Permissions | Optional | |||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. Page Index is only available when UserId or Username is specified. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. Page Size is only available when UserId or Username is specified. | Optional | |||
PermissionId | string | Permission Id | Optional | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/{application}/{id}/roles.json', data: { 'application': 'application', 'id': '6' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Roles": [ { "Id": 6, "RoleId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "fe65240b-044c-4292-9946-f10e0361ecff", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, { "Id": 8, "RoleId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "Name": "name", "Description": "description", "GroupId": 4, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Roles> <Role> <Id>6</Id> <RoleId>49fec544-6df7-4a82-872b-f8be586d5e9e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> <Role> <Id>8</Id> <RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>4</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> </Roles> </Response>
GET api.ashx/v2/{application}/{id}/roles/permissions.{json|xml}
LIST roles with permissions for an application.
Scopes
Security(Roles and Permissions) › Read Roles security.roles.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Application | string | Application | Required | |||
Id | int? | Id | Optional | |||
Include | string | Options for include are user, granted, or denied. Ex: include=granted. | Optional | |||
IncludePermissions | bool | Include Permissions | Optional | |||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. Page Index is only available when UserId or Username is specified. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. Page Size is only available when UserId or Username is specified. | Optional | |||
PermissionId | string | Permission Id | Optional | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/{application}/{id}/roles/permissions.json', data: { 'application': 'application', 'id': '6' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Roles": [ { "Id": 6, "RoleId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "fe65240b-044c-4292-9946-f10e0361ecff", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, { "Id": 8, "RoleId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "Name": "name", "Description": "description", "GroupId": 4, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Roles> <Role> <Id>6</Id> <RoleId>49fec544-6df7-4a82-872b-f8be586d5e9e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> <Role> <Id>8</Id> <RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>4</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> </Roles> </Response>
GET api.ashx/v2/{application}/{id}/roles/permissions/{permissionid}.{json|xml}
LIST roles with permission for an application.
Scopes
Security(Roles and Permissions) › Read Roles security.roles.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Application | string | Application | Required | |||
Id | int? | Id | Optional | |||
Include | string | Options for include are user, granted, or denied. Ex: include=granted. | Optional | |||
IncludePermissions | bool | Include Permissions | Optional | |||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. Page Index is only available when UserId or Username is specified. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. Page Size is only available when UserId or Username is specified. | Optional | |||
PermissionId | string | Permission Id | Optional | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/{application}/{id}/roles/permissions/{permissionid}.json', data: { 'application': 'application', 'id': '6', 'permissionid': 'permissionid' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Roles": [ { "Id": 6, "RoleId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "fe65240b-044c-4292-9946-f10e0361ecff", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, { "Id": 8, "RoleId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "Name": "name", "Description": "description", "GroupId": 4, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Roles> <Role> <Id>6</Id> <RoleId>49fec544-6df7-4a82-872b-f8be586d5e9e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> <Role> <Id>8</Id> <RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>4</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> </Roles> </Response>
GET api.ashx/v2/{application}/{id}/roles/permissions/user/{userid}.{json|xml}
LIST roles with permissions for a user by user id for an application.
Scopes
Security(Roles and Permissions) › Read Roles security.roles.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Application | string | Application | Required | |||
Id | int? | Id | Optional | |||
Include | string | Options for include are user, granted, or denied. Ex: include=granted. | Optional | |||
IncludePermissions | bool | Include Permissions | Optional | |||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. Page Index is only available when UserId or Username is specified. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. Page Size is only available when UserId or Username is specified. | Optional | |||
PermissionId | string | Permission Id | Optional | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/{application}/{id}/roles/permissions/user/{userid}.json', data: { 'application': 'application', 'id': '6', 'userid': '6' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Roles": [ { "Id": 6, "RoleId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "fe65240b-044c-4292-9946-f10e0361ecff", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, { "Id": 8, "RoleId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "Name": "name", "Description": "description", "GroupId": 4, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Roles> <Role> <Id>6</Id> <RoleId>49fec544-6df7-4a82-872b-f8be586d5e9e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> <Role> <Id>8</Id> <RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>4</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> </Roles> </Response>
GET api.ashx/v2/{application}/{id}/roles/permissions/user/{username}.{json|xml}
LIST roles with permissions for a user by username for an application.
Scopes
Security(Roles and Permissions) › Read Roles security.roles.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Application | string | Application | Required | |||
Id | int? | Id | Optional | |||
Include | string | Options for include are user, granted, or denied. Ex: include=granted. | Optional | |||
IncludePermissions | bool | Include Permissions | Optional | |||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. Page Index is only available when UserId or Username is specified. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. Page Size is only available when UserId or Username is specified. | Optional | |||
PermissionId | string | Permission Id | Optional | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/{application}/{id}/roles/permissions/user/{username}.json', data: { 'application': 'application', 'id': '6', 'username': 'username' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Roles": [ { "Id": 6, "RoleId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "fe65240b-044c-4292-9946-f10e0361ecff", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, { "Id": 8, "RoleId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "Name": "name", "Description": "description", "GroupId": 4, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Roles> <Role> <Id>6</Id> <RoleId>49fec544-6df7-4a82-872b-f8be586d5e9e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> <Role> <Id>8</Id> <RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>4</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> </Roles> </Response>
GET api.ashx/v2/{application}/{id}/roles/user/{userid}.{json|xml}
LIST roles for a user by user id for an application.
Scopes
Security(Roles and Permissions) › Read Roles security.roles.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Application | string | Application | Required | |||
Id | int? | Id | Optional | |||
Include | string | Options for include are user, granted, or denied. Ex: include=granted. | Optional | |||
IncludePermissions | bool | Include Permissions | Optional | |||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. Page Index is only available when UserId or Username is specified. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. Page Size is only available when UserId or Username is specified. | Optional | |||
PermissionId | string | Permission Id | Optional | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/{application}/{id}/roles/user/{userid}.json', data: { 'application': 'application', 'id': '6', 'userid': '6' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Roles": [ { "Id": 6, "RoleId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "fe65240b-044c-4292-9946-f10e0361ecff", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, { "Id": 8, "RoleId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "Name": "name", "Description": "description", "GroupId": 4, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Roles> <Role> <Id>6</Id> <RoleId>49fec544-6df7-4a82-872b-f8be586d5e9e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> <Role> <Id>8</Id> <RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>4</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> </Roles> </Response>
GET api.ashx/v2/{application}/{id}/roles/user/{username}.{json|xml}
LIST roles for a user by username for an application.
Scopes
Security(Roles and Permissions) › Read Roles security.roles.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Application | string | Application | Required | |||
Id | int? | Id | Optional | |||
Include | string | Options for include are user, granted, or denied. Ex: include=granted. | Optional | |||
IncludePermissions | bool | Include Permissions | Optional | |||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. Page Index is only available when UserId or Username is specified. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. Page Size is only available when UserId or Username is specified. | Optional | |||
PermissionId | string | Permission Id | Optional | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/{application}/{id}/roles/user/{username}.json', data: { 'application': 'application', 'id': '6', 'username': 'username' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Roles": [ { "Id": 6, "RoleId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "fe65240b-044c-4292-9946-f10e0361ecff", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, { "Id": 8, "RoleId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "Name": "name", "Description": "description", "GroupId": 4, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Roles> <Role> <Id>6</Id> <RoleId>49fec544-6df7-4a82-872b-f8be586d5e9e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> <Role> <Id>8</Id> <RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>4</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> </Roles> </Response>
GET api.ashx/v2/roles.{json|xml}
LIST all roles.
Scopes
Security(Roles and Permissions) › Read Roles security.roles.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Application | string | Application | Required | |||
Id | int? | Id | Optional | |||
Include | string | Options for include are user, granted, or denied. Ex: include=granted. | Optional | |||
IncludePermissions | bool | Include Permissions | Optional | |||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. Page Index is only available when UserId or Username is specified. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. Page Size is only available when UserId or Username is specified. | Optional | |||
PermissionId | string | Permission Id | Optional | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/roles.json?Application=application', data: { 'Application': 'application' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Roles": [ { "Id": 6, "RoleId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "fe65240b-044c-4292-9946-f10e0361ecff", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, { "Id": 8, "RoleId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "Name": "name", "Description": "description", "GroupId": 4, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Roles> <Role> <Id>6</Id> <RoleId>49fec544-6df7-4a82-872b-f8be586d5e9e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> <Role> <Id>8</Id> <RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>4</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> </Roles> </Response>
GET api.ashx/v2/roles/permissions.{json|xml}
LIST all roles with permissions.
Scopes
Security(Roles and Permissions) › Read Roles security.roles.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Application | string | Application | Required | |||
Id | int? | Id | Optional | |||
Include | string | Options for include are user, granted, or denied. Ex: include=granted. | Optional | |||
IncludePermissions | bool | Include Permissions | Optional | |||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. Page Index is only available when UserId or Username is specified. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. Page Size is only available when UserId or Username is specified. | Optional | |||
PermissionId | string | Permission Id | Optional | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/roles/permissions.json?Application=application', data: { 'Application': 'application' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Roles": [ { "Id": 6, "RoleId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "fe65240b-044c-4292-9946-f10e0361ecff", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, { "Id": 8, "RoleId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "Name": "name", "Description": "description", "GroupId": 4, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Roles> <Role> <Id>6</Id> <RoleId>49fec544-6df7-4a82-872b-f8be586d5e9e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> <Role> <Id>8</Id> <RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>4</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> </Roles> </Response>
GET api.ashx/v2/roles/permissions/{permissionid}.{json|xml}
LIST roles with permission.
Scopes
Security(Roles and Permissions) › Read Roles security.roles.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Application | string | Application | Required | |||
Id | int? | Id | Optional | |||
Include | string | Options for include are user, granted, or denied. Ex: include=granted. | Optional | |||
IncludePermissions | bool | Include Permissions | Optional | |||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. Page Index is only available when UserId or Username is specified. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. Page Size is only available when UserId or Username is specified. | Optional | |||
PermissionId | string | Permission Id | Optional | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/roles/permissions/{permissionid}.json?Application=application', data: { 'permissionid': 'permissionid', 'Application': 'application' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Roles": [ { "Id": 6, "RoleId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "fe65240b-044c-4292-9946-f10e0361ecff", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, { "Id": 8, "RoleId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "Name": "name", "Description": "description", "GroupId": 4, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Roles> <Role> <Id>6</Id> <RoleId>49fec544-6df7-4a82-872b-f8be586d5e9e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> <Role> <Id>8</Id> <RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>4</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> </Roles> </Response>
GET api.ashx/v2/roles/permissions/user/{userid}.{json|xml}
LIST roles with permissions for a user by user id.
Scopes
Security(Roles and Permissions) › Read Roles security.roles.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Application | string | Application | Required | |||
Id | int? | Id | Optional | |||
Include | string | Options for include are user, granted, or denied. Ex: include=granted. | Optional | |||
IncludePermissions | bool | Include Permissions | Optional | |||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. Page Index is only available when UserId or Username is specified. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. Page Size is only available when UserId or Username is specified. | Optional | |||
PermissionId | string | Permission Id | Optional | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/roles/permissions/user/{userid}.json?Application=application', data: { 'userid': '6', 'Application': 'application' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Roles": [ { "Id": 6, "RoleId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "fe65240b-044c-4292-9946-f10e0361ecff", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, { "Id": 8, "RoleId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "Name": "name", "Description": "description", "GroupId": 4, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Roles> <Role> <Id>6</Id> <RoleId>49fec544-6df7-4a82-872b-f8be586d5e9e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> <Role> <Id>8</Id> <RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>4</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> </Roles> </Response>
GET api.ashx/v2/roles/permissions/user/{username}.{json|xml}
LIST roles with permissions for a user by username.
Scopes
Security(Roles and Permissions) › Read Roles security.roles.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Application | string | Application | Required | |||
Id | int? | Id | Optional | |||
Include | string | Options for include are user, granted, or denied. Ex: include=granted. | Optional | |||
IncludePermissions | bool | Include Permissions | Optional | |||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. Page Index is only available when UserId or Username is specified. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. Page Size is only available when UserId or Username is specified. | Optional | |||
PermissionId | string | Permission Id | Optional | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/roles/permissions/user/{username}.json?Application=application', data: { 'username': 'username', 'Application': 'application' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Roles": [ { "Id": 6, "RoleId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "fe65240b-044c-4292-9946-f10e0361ecff", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, { "Id": 8, "RoleId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "Name": "name", "Description": "description", "GroupId": 4, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Roles> <Role> <Id>6</Id> <RoleId>49fec544-6df7-4a82-872b-f8be586d5e9e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> <Role> <Id>8</Id> <RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>4</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> </Roles> </Response>
GET api.ashx/v2/roles/user/{userid}.{json|xml}
LIST roles for a user by user id.
Scopes
Security(Roles and Permissions) › Read Roles security.roles.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Application | string | Application | Required | |||
Id | int? | Id | Optional | |||
Include | string | Options for include are user, granted, or denied. Ex: include=granted. | Optional | |||
IncludePermissions | bool | Include Permissions | Optional | |||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. Page Index is only available when UserId or Username is specified. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. Page Size is only available when UserId or Username is specified. | Optional | |||
PermissionId | string | Permission Id | Optional | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/roles/user/{userid}.json?Application=application', data: { 'userid': '6', 'Application': 'application' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Roles": [ { "Id": 6, "RoleId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "fe65240b-044c-4292-9946-f10e0361ecff", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, { "Id": 8, "RoleId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "Name": "name", "Description": "description", "GroupId": 4, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Roles> <Role> <Id>6</Id> <RoleId>49fec544-6df7-4a82-872b-f8be586d5e9e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> <Role> <Id>8</Id> <RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>4</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> </Roles> </Response>
GET api.ashx/v2/roles/user/{username}.{json|xml}
LIST roles for a user by username.
Scopes
Security(Roles and Permissions) › Read Roles security.roles.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Application | string | Application | Required | |||
Id | int? | Id | Optional | |||
Include | string | Options for include are user, granted, or denied. Ex: include=granted. | Optional | |||
IncludePermissions | bool | Include Permissions | Optional | |||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. Page Index is only available when UserId or Username is specified. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. Page Size is only available when UserId or Username is specified. | Optional | |||
PermissionId | string | Permission Id | Optional | |||
UserId | int? | Either UserId or Username are required when using include=user | Optional | |||
Username | string | Either UserId or Username are required when using include=user | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/roles/user/{username}.json?Application=application', data: { 'username': 'username', 'Application': 'application' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Roles": [ { "Id": 6, "RoleId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Name": "name", "Description": "description", "GroupId": 25, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "fe65240b-044c-4292-9946-f10e0361ecff", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] }, { "Id": 8, "RoleId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "Name": "name", "Description": "description", "GroupId": 4, "IsSystemRole": true, "ImageUrl": "", "AvatarUrl": "avatarurl", "IsPrivate": true, "PermissionEntries": [ { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true }, { "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "PermissionId": "permissionid", "Name": "name", "IsAllowed": true, "IsImmediate": true } ] } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Roles> <Role> <Id>6</Id> <RoleId>49fec544-6df7-4a82-872b-f8be586d5e9e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>25</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> <Role> <Id>8</Id> <RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId> <Name>name</Name> <Description>description</Description> <GroupId>4</GroupId> <IsSystemRole>true</IsSystemRole> <AvatarUrl>avatarurl</AvatarUrl> <IsPrivate>true</IsPrivate> <PermissionEntries> <PermissionEntry> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> <PermissionEntry> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <PermissionId>permissionid</PermissionId> <Name>name</Name> <IsAllowed>true</IsAllowed> <IsImmediate>true</IsImmediate> </PermissionEntry> </PermissionEntries> </Role> </Roles> </Response>