TeamDynamix Web API: Security Roles

Unless explicitly stated on the documentation for a method, the accepted Web API call content types are:

application/json

Calls using any other content type (ex: text/plain) are not supported.

Summary
Methods
- GET https://td.usnh.edu/TDWebApi/api/securityroles/{id}
  Gets a security role.
- PUT https://td.usnh.edu/TDWebApi/api/securityroles/{id}?useDefaultPermissions={useDefaultPermissions}
  Edits the specified security role.
- GET https://td.usnh.edu/TDWebApi/api/securityroles/permissions?forAppId={forAppId}&forLicenseType={forLicenseType}&onlyDefault={onlyDefault}
  Gets a list of available permissions for the specified application and optionally for the specified license type.
- POST https://td.usnh.edu/TDWebApi/api/securityroles/search
  Gets a list of security roles.
- POST https://td.usnh.edu/TDWebApi/api/securityroles?useDefaultPermissions={useDefaultPermissions}
  Creates a security role.

Summary

Contains methods for working with security roles.

API Methods

GET https://td.usnh.edu/TDWebApi/api/securityroles/{id} Copy URL

Gets a security role.

Parameters

Parameter Name

id

Type

Guid

Source

URI

Description

The security role ID.

Returns

The security role if it was found. (TeamDynamix.Api.Roles.SecurityRole)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

PUT https://td.usnh.edu/TDWebApi/api/securityroles/{id}?useDefaultPermissions={useDefaultPermissions} Copy URL

Edits the specified security role.

Parameters

Parameter Name

id

Type

Guid

Source

URI

Description

The ID of the role.
Parameter Name

useDefaultPermissions

Type

Boolean

Source

URI

Description

if set to true the default license type permissions will be used for the security role; otherwise, false
Parameter Name

Request Body (Validated as "role")

Type

TeamDynamix.Api.Roles.SecurityRole

Source

Request Body

Description

The security role with updated values.

Returns

The updated security role. (TeamDynamix.Api.Roles.SecurityRole)

Access Restrictions

This action can only be performed by special key-based administrative service accounts and not standard TeamDynamix users.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

GET https://td.usnh.edu/TDWebApi/api/securityroles/permissions?forAppId={forAppId}&forLicenseType={forLicenseType}&onlyDefault={onlyDefault} Copy URL

Gets a list of available permissions for the specified application and optionally for the specified license type.

Parameters

Parameter Name

forAppId

Type

Int32

Source

URI

Description

The ID of the application for which permissions will be retrieved. If 0, will return permissions available for global security roles.
Parameter Name

forLicenseType

Type

TeamDynamix.Api.Roles.LicenseTypes

Source

URI

Default

This parameter is optional, with a default value of None.

Description

The ID of the license type for which permissions will be filtered down. Optional.
Parameter Name

onlyDefault

Type

Boolean

Source

URI

Default

This parameter is optional, with a default value of False.

Description

If true, will filter down permissions to only the default for the license type. Only applicable when a license type is specified. Optional.

Returns

A list of matching permissions. (TeamDynamix.Api.Roles.Permission[])

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

POST https://td.usnh.edu/TDWebApi/api/securityroles/search Copy URL

Gets a list of security roles.

Parameters

Parameter Name

Request Body (Validated as "search")

Type

TeamDynamix.Api.Roles.SecurityRoleSearch

Source

Request Body

Description

The searching parameters to use.

Returns

A list of security roles. In the interest of performance, subcollections such as TeamDynamix.Api.Roles.SecurityRole.Permissions will not be loaded. (TeamDynamix.Api.Roles.SecurityRole[])

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

POST https://td.usnh.edu/TDWebApi/api/securityroles?useDefaultPermissions={useDefaultPermissions} Copy URL

Creates a security role.

Parameters

Parameter Name

useDefaultPermissions

Type

Boolean

Source

URI

Description

if set to true the default permissions for the license type will be used.
Parameter Name

Request Body (Validated as "role")

Type

TeamDynamix.Api.Roles.SecurityRole

Source

Request Body

Description

The role to create.

Returns

The newly-created security role (TeamDynamix.Api.Roles.SecurityRole)

Access Restrictions

This action can only be performed by special key-based administrative service accounts and not standard TeamDynamix users.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Contents

Summary

API Methods

GET https://td.usnh.edu/TDWebApi/api/securityroles/{id} Copy URL

Parameters

id

Returns

Rate/Submission Limitations

PUT https://td.usnh.edu/TDWebApi/api/securityroles/{id}?useDefaultPermissions={useDefaultPermissions} Copy URL

Parameters

id

useDefaultPermissions

Request Body (Validated as "role")

Returns

Access Restrictions

Rate/Submission Limitations

GET https://td.usnh.edu/TDWebApi/api/securityroles/permissions?forAppId={forAppId}&forLicenseType={forLicenseType}&onlyDefault={onlyDefault} Copy URL

Parameters

forAppId

forLicenseType

onlyDefault

Returns

Rate/Submission Limitations

POST https://td.usnh.edu/TDWebApi/api/securityroles/search Copy URL

Parameters

Request Body (Validated as "search")

Returns

Rate/Submission Limitations

POST https://td.usnh.edu/TDWebApi/api/securityroles?useDefaultPermissions={useDefaultPermissions} Copy URL

Parameters

useDefaultPermissions

Request Body (Validated as "role")

Returns

Access Restrictions

Rate/Submission Limitations