1. APIs
  2. Security Roles

Contents

Summary

Contains methods for working with security roles.

API Methods

GET https://services.dartmouth.edu/TDWebApi/api/securityroles/{id} Copy URL

Gets a security role.

Parameters

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://services.dartmouth.edu/TDWebApi/api/securityroles/{id}?useDefaultPermissions={useDefaultPermissions} Copy URL

Edits the specified security role.

Parameters

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://services.dartmouth.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

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://services.dartmouth.edu/TDWebApi/api/securityroles/search Copy URL

Gets a list of security roles.

Parameters

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://services.dartmouth.edu/TDWebApi/api/securityroles?useDefaultPermissions={useDefaultPermissions} Copy URL

Creates a security role.

Parameters

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.