Docs
Start for free Sign in
Theme
Sign in Start for free
Docs
    Start for free

    User Roles

    Get a list of User Roles

    GET /api/userroles

    Lists all of the User Roles in the current Octopus Deploy instance. The results will be sorted alphabetically by name.

    Query Parameters

    • ids array of string
      A list of User Role IDs, to limit the result to those with a particular ID. Example: [“UserRoles-1”, “UserRoles-2”].
    • partialName string
      A partial name, to limit the result to those with a name that includes the partial name.
    • skip integer
      Number of items to skip. Defaults to zero. Minimum 0.
    • take integer
      Number of items to take. Defaults to 30. Minimum 0.

    Response

    200 — Request list of user roles.

    • Id string
      Gets or sets a unique identifier for this resource.
    • ItemType string
    • Items array of object
      • CanBeDeleted boolean
      • Description string
      • GrantedSpacePermissions array of enum
        Allowed values: AdministerSystem, ProjectEdit, ProjectView, ProjectCreate, ProjectDelete, ProcessView, ProcessEdit, VariableEdit, VariableEditUnscoped, VariableView, VariableViewUnscoped, ReleaseCreate, ReleaseView, ReleaseEdit, ReleaseDelete, DefectReport, DefectResolve, DeploymentCreate, DeploymentDelete, DeploymentView, EnvironmentView, EnvironmentCreate, EnvironmentEdit, EnvironmentDelete, MachineCreate, MachineEdit, MachineView, MachineDelete, ArtifactView, ArtifactCreate, ArtifactEdit, ArtifactDelete, FeedView, EventView, LibraryVariableSetView, LibraryVariableSetCreate, LibraryVariableSetEdit, LibraryVariableSetDelete, ProjectGroupView, ProjectGroupCreate, ProjectGroupEdit, ProjectGroupDelete, TeamCreate, TeamView, TeamEdit, TeamDelete, UserView, UserInvite, UserRoleView, UserRoleEdit, TaskView, TaskCreate, TaskCancel, TaskEdit, TaskPrioritize, InterruptionView, InterruptionSubmit, InterruptionViewSubmitResponsible, BuiltInFeedPush, BuiltInFeedAdminister, BuiltInFeedDownload, ActionTemplateView, ActionTemplateCreate, ActionTemplateEdit, ActionTemplateDelete, LifecycleCreate, LifecycleView, LifecycleEdit, LifecycleDelete, AccountView, AccountEdit, AccountCreate, AccountDelete, TenantCreate, TenantEdit, TenantView, TenantDelete, TagSetCreate, TagSetEdit, TagSetDelete, TelemetryView, MachinePolicyCreate, MachinePolicyView, MachinePolicyEdit, MachinePolicyDelete, ProxyCreate, ProxyView, ProxyEdit, ProxyDelete, SubscriptionCreate, SubscriptionView, SubscriptionEdit, SubscriptionDelete, TriggerCreate, TriggerView, TriggerEdit, TriggerDelete, CertificateView, CertificateCreate, CertificateEdit, CertificateDelete, CertificateExportPrivateKey, UserEdit, ConfigureServer, FeedEdit, WorkerView, WorkerEdit, SpaceEdit, SpaceView, SpaceDelete, SpaceCreate, BuildInformationPush, BuildInformationAdminister, RunbookView, RunbookEdit, RunbookSnapshotCreate, RunbookRunView, RunbookRunDelete, RunbookRunCreate, GitCredentialView, GitCredentialEdit, EventRetentionDelete, EventRetentionView, InsightsReportView, InsightsReportCreate, InsightsReportEdit, InsightsReportDelete, DeploymentFreezeAdminister, TargetTagView, TargetTagAdminister, PlatformHubView, PlatformHubEdit, RetentionAdminister, FeatureToggleEdit, ApprovalPolicyAdminister, SshKnownHostsAdminister, SshKnownHostsView, AiAgentTranscriptView, DeployedResourceAdminister.
      • GrantedSystemPermissions array of enum
        Allowed values: AdministerSystem, ProjectEdit, ProjectView, ProjectCreate, ProjectDelete, ProcessView, ProcessEdit, VariableEdit, VariableEditUnscoped, VariableView, VariableViewUnscoped, ReleaseCreate, ReleaseView, ReleaseEdit, ReleaseDelete, DefectReport, DefectResolve, DeploymentCreate, DeploymentDelete, DeploymentView, EnvironmentView, EnvironmentCreate, EnvironmentEdit, EnvironmentDelete, MachineCreate, MachineEdit, MachineView, MachineDelete, ArtifactView, ArtifactCreate, ArtifactEdit, ArtifactDelete, FeedView, EventView, LibraryVariableSetView, LibraryVariableSetCreate, LibraryVariableSetEdit, LibraryVariableSetDelete, ProjectGroupView, ProjectGroupCreate, ProjectGroupEdit, ProjectGroupDelete, TeamCreate, TeamView, TeamEdit, TeamDelete, UserView, UserInvite, UserRoleView, UserRoleEdit, TaskView, TaskCreate, TaskCancel, TaskEdit, TaskPrioritize, InterruptionView, InterruptionSubmit, InterruptionViewSubmitResponsible, BuiltInFeedPush, BuiltInFeedAdminister, BuiltInFeedDownload, ActionTemplateView, ActionTemplateCreate, ActionTemplateEdit, ActionTemplateDelete, LifecycleCreate, LifecycleView, LifecycleEdit, LifecycleDelete, AccountView, AccountEdit, AccountCreate, AccountDelete, TenantCreate, TenantEdit, TenantView, TenantDelete, TagSetCreate, TagSetEdit, TagSetDelete, TelemetryView, MachinePolicyCreate, MachinePolicyView, MachinePolicyEdit, MachinePolicyDelete, ProxyCreate, ProxyView, ProxyEdit, ProxyDelete, SubscriptionCreate, SubscriptionView, SubscriptionEdit, SubscriptionDelete, TriggerCreate, TriggerView, TriggerEdit, TriggerDelete, CertificateView, CertificateCreate, CertificateEdit, CertificateDelete, CertificateExportPrivateKey, UserEdit, ConfigureServer, FeedEdit, WorkerView, WorkerEdit, SpaceEdit, SpaceView, SpaceDelete, SpaceCreate, BuildInformationPush, BuildInformationAdminister, RunbookView, RunbookEdit, RunbookSnapshotCreate, RunbookRunView, RunbookRunDelete, RunbookRunCreate, GitCredentialView, GitCredentialEdit, EventRetentionDelete, EventRetentionView, InsightsReportView, InsightsReportCreate, InsightsReportEdit, InsightsReportDelete, DeploymentFreezeAdminister, TargetTagView, TargetTagAdminister, PlatformHubView, PlatformHubEdit, RetentionAdminister, FeatureToggleEdit, ApprovalPolicyAdminister, SshKnownHostsAdminister, SshKnownHostsView, AiAgentTranscriptView, DeployedResourceAdminister.
      • Id string
        Gets or sets a unique identifier for this resource.
      • LastModifiedBy string
        Gets or sets the username of the user who last modified this resource.
      • LastModifiedOn string
        Gets or sets the date/time that this resource was last modified. Format date-time.
      • Links object
        Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
      • Name string
      • SpacePermissionDescriptions array of string
      • SupportedRestrictions array of string
      • SystemPermissionDescriptions array of string
    • ItemsPerPage integer
    • LastModifiedBy string
      Gets or sets the username of the user who last modified this resource.
    • LastModifiedOn string
      Gets or sets the date/time that this resource was last modified. Format date-time.
    • LastPageNumber integer
    • Links object
      Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
    • NumberOfPages integer
    • TotalResults integer

    Example Response

    JSON
    {
  "Id": "string",
  "ItemType": "string",
  "Items": [
    {
      "CanBeDeleted": true,
      "Description": "string",
      "GrantedSpacePermissions": [
        "AdministerSystem"
      ],
      "GrantedSystemPermissions": [
        "AdministerSystem"
      ],
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "SpacePermissionDescriptions": [
        "string"
      ],
      "SupportedRestrictions": [
        "string"
      ],
      "SystemPermissionDescriptions": [
        "string"
      ]
    }
  ],
  "ItemsPerPage": 0,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LastPageNumber": 0,
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "NumberOfPages": 0,
  "TotalResults": 0
}

    Create a custom user role definition

    POST /api/userroles

    Request Body

    • Description string
    • GrantedSpacePermissions array of enum
      Allowed values: AdministerSystem, ProjectEdit, ProjectView, ProjectCreate, ProjectDelete, ProcessView, ProcessEdit, VariableEdit, VariableEditUnscoped, VariableView, VariableViewUnscoped, ReleaseCreate, ReleaseView, ReleaseEdit, ReleaseDelete, DefectReport, DefectResolve, DeploymentCreate, DeploymentDelete, DeploymentView, EnvironmentView, EnvironmentCreate, EnvironmentEdit, EnvironmentDelete, MachineCreate, MachineEdit, MachineView, MachineDelete, ArtifactView, ArtifactCreate, ArtifactEdit, ArtifactDelete, FeedView, EventView, LibraryVariableSetView, LibraryVariableSetCreate, LibraryVariableSetEdit, LibraryVariableSetDelete, ProjectGroupView, ProjectGroupCreate, ProjectGroupEdit, ProjectGroupDelete, TeamCreate, TeamView, TeamEdit, TeamDelete, UserView, UserInvite, UserRoleView, UserRoleEdit, TaskView, TaskCreate, TaskCancel, TaskEdit, TaskPrioritize, InterruptionView, InterruptionSubmit, InterruptionViewSubmitResponsible, BuiltInFeedPush, BuiltInFeedAdminister, BuiltInFeedDownload, ActionTemplateView, ActionTemplateCreate, ActionTemplateEdit, ActionTemplateDelete, LifecycleCreate, LifecycleView, LifecycleEdit, LifecycleDelete, AccountView, AccountEdit, AccountCreate, AccountDelete, TenantCreate, TenantEdit, TenantView, TenantDelete, TagSetCreate, TagSetEdit, TagSetDelete, TelemetryView, MachinePolicyCreate, MachinePolicyView, MachinePolicyEdit, MachinePolicyDelete, ProxyCreate, ProxyView, ProxyEdit, ProxyDelete, SubscriptionCreate, SubscriptionView, SubscriptionEdit, SubscriptionDelete, TriggerCreate, TriggerView, TriggerEdit, TriggerDelete, CertificateView, CertificateCreate, CertificateEdit, CertificateDelete, CertificateExportPrivateKey, UserEdit, ConfigureServer, FeedEdit, WorkerView, WorkerEdit, SpaceEdit, SpaceView, SpaceDelete, SpaceCreate, BuildInformationPush, BuildInformationAdminister, RunbookView, RunbookEdit, RunbookSnapshotCreate, RunbookRunView, RunbookRunDelete, RunbookRunCreate, GitCredentialView, GitCredentialEdit, EventRetentionDelete, EventRetentionView, InsightsReportView, InsightsReportCreate, InsightsReportEdit, InsightsReportDelete, DeploymentFreezeAdminister, TargetTagView, TargetTagAdminister, PlatformHubView, PlatformHubEdit, RetentionAdminister, FeatureToggleEdit, ApprovalPolicyAdminister, SshKnownHostsAdminister, SshKnownHostsView, AiAgentTranscriptView, DeployedResourceAdminister.
    • GrantedSystemPermissions array of enum
      Allowed values: AdministerSystem, ProjectEdit, ProjectView, ProjectCreate, ProjectDelete, ProcessView, ProcessEdit, VariableEdit, VariableEditUnscoped, VariableView, VariableViewUnscoped, ReleaseCreate, ReleaseView, ReleaseEdit, ReleaseDelete, DefectReport, DefectResolve, DeploymentCreate, DeploymentDelete, DeploymentView, EnvironmentView, EnvironmentCreate, EnvironmentEdit, EnvironmentDelete, MachineCreate, MachineEdit, MachineView, MachineDelete, ArtifactView, ArtifactCreate, ArtifactEdit, ArtifactDelete, FeedView, EventView, LibraryVariableSetView, LibraryVariableSetCreate, LibraryVariableSetEdit, LibraryVariableSetDelete, ProjectGroupView, ProjectGroupCreate, ProjectGroupEdit, ProjectGroupDelete, TeamCreate, TeamView, TeamEdit, TeamDelete, UserView, UserInvite, UserRoleView, UserRoleEdit, TaskView, TaskCreate, TaskCancel, TaskEdit, TaskPrioritize, InterruptionView, InterruptionSubmit, InterruptionViewSubmitResponsible, BuiltInFeedPush, BuiltInFeedAdminister, BuiltInFeedDownload, ActionTemplateView, ActionTemplateCreate, ActionTemplateEdit, ActionTemplateDelete, LifecycleCreate, LifecycleView, LifecycleEdit, LifecycleDelete, AccountView, AccountEdit, AccountCreate, AccountDelete, TenantCreate, TenantEdit, TenantView, TenantDelete, TagSetCreate, TagSetEdit, TagSetDelete, TelemetryView, MachinePolicyCreate, MachinePolicyView, MachinePolicyEdit, MachinePolicyDelete, ProxyCreate, ProxyView, ProxyEdit, ProxyDelete, SubscriptionCreate, SubscriptionView, SubscriptionEdit, SubscriptionDelete, TriggerCreate, TriggerView, TriggerEdit, TriggerDelete, CertificateView, CertificateCreate, CertificateEdit, CertificateDelete, CertificateExportPrivateKey, UserEdit, ConfigureServer, FeedEdit, WorkerView, WorkerEdit, SpaceEdit, SpaceView, SpaceDelete, SpaceCreate, BuildInformationPush, BuildInformationAdminister, RunbookView, RunbookEdit, RunbookSnapshotCreate, RunbookRunView, RunbookRunDelete, RunbookRunCreate, GitCredentialView, GitCredentialEdit, EventRetentionDelete, EventRetentionView, InsightsReportView, InsightsReportCreate, InsightsReportEdit, InsightsReportDelete, DeploymentFreezeAdminister, TargetTagView, TargetTagAdminister, PlatformHubView, PlatformHubEdit, RetentionAdminister, FeatureToggleEdit, ApprovalPolicyAdminister, SshKnownHostsAdminister, SshKnownHostsView, AiAgentTranscriptView, DeployedResourceAdminister.
    • Name string (required)
      Minimum length 1.

    Response

    201 — Created

    • CanBeDeleted boolean
    • Description string
    • GrantedSpacePermissions array of enum
      Allowed values: AdministerSystem, ProjectEdit, ProjectView, ProjectCreate, ProjectDelete, ProcessView, ProcessEdit, VariableEdit, VariableEditUnscoped, VariableView, VariableViewUnscoped, ReleaseCreate, ReleaseView, ReleaseEdit, ReleaseDelete, DefectReport, DefectResolve, DeploymentCreate, DeploymentDelete, DeploymentView, EnvironmentView, EnvironmentCreate, EnvironmentEdit, EnvironmentDelete, MachineCreate, MachineEdit, MachineView, MachineDelete, ArtifactView, ArtifactCreate, ArtifactEdit, ArtifactDelete, FeedView, EventView, LibraryVariableSetView, LibraryVariableSetCreate, LibraryVariableSetEdit, LibraryVariableSetDelete, ProjectGroupView, ProjectGroupCreate, ProjectGroupEdit, ProjectGroupDelete, TeamCreate, TeamView, TeamEdit, TeamDelete, UserView, UserInvite, UserRoleView, UserRoleEdit, TaskView, TaskCreate, TaskCancel, TaskEdit, TaskPrioritize, InterruptionView, InterruptionSubmit, InterruptionViewSubmitResponsible, BuiltInFeedPush, BuiltInFeedAdminister, BuiltInFeedDownload, ActionTemplateView, ActionTemplateCreate, ActionTemplateEdit, ActionTemplateDelete, LifecycleCreate, LifecycleView, LifecycleEdit, LifecycleDelete, AccountView, AccountEdit, AccountCreate, AccountDelete, TenantCreate, TenantEdit, TenantView, TenantDelete, TagSetCreate, TagSetEdit, TagSetDelete, TelemetryView, MachinePolicyCreate, MachinePolicyView, MachinePolicyEdit, MachinePolicyDelete, ProxyCreate, ProxyView, ProxyEdit, ProxyDelete, SubscriptionCreate, SubscriptionView, SubscriptionEdit, SubscriptionDelete, TriggerCreate, TriggerView, TriggerEdit, TriggerDelete, CertificateView, CertificateCreate, CertificateEdit, CertificateDelete, CertificateExportPrivateKey, UserEdit, ConfigureServer, FeedEdit, WorkerView, WorkerEdit, SpaceEdit, SpaceView, SpaceDelete, SpaceCreate, BuildInformationPush, BuildInformationAdminister, RunbookView, RunbookEdit, RunbookSnapshotCreate, RunbookRunView, RunbookRunDelete, RunbookRunCreate, GitCredentialView, GitCredentialEdit, EventRetentionDelete, EventRetentionView, InsightsReportView, InsightsReportCreate, InsightsReportEdit, InsightsReportDelete, DeploymentFreezeAdminister, TargetTagView, TargetTagAdminister, PlatformHubView, PlatformHubEdit, RetentionAdminister, FeatureToggleEdit, ApprovalPolicyAdminister, SshKnownHostsAdminister, SshKnownHostsView, AiAgentTranscriptView, DeployedResourceAdminister.
    • GrantedSystemPermissions array of enum
      Allowed values: AdministerSystem, ProjectEdit, ProjectView, ProjectCreate, ProjectDelete, ProcessView, ProcessEdit, VariableEdit, VariableEditUnscoped, VariableView, VariableViewUnscoped, ReleaseCreate, ReleaseView, ReleaseEdit, ReleaseDelete, DefectReport, DefectResolve, DeploymentCreate, DeploymentDelete, DeploymentView, EnvironmentView, EnvironmentCreate, EnvironmentEdit, EnvironmentDelete, MachineCreate, MachineEdit, MachineView, MachineDelete, ArtifactView, ArtifactCreate, ArtifactEdit, ArtifactDelete, FeedView, EventView, LibraryVariableSetView, LibraryVariableSetCreate, LibraryVariableSetEdit, LibraryVariableSetDelete, ProjectGroupView, ProjectGroupCreate, ProjectGroupEdit, ProjectGroupDelete, TeamCreate, TeamView, TeamEdit, TeamDelete, UserView, UserInvite, UserRoleView, UserRoleEdit, TaskView, TaskCreate, TaskCancel, TaskEdit, TaskPrioritize, InterruptionView, InterruptionSubmit, InterruptionViewSubmitResponsible, BuiltInFeedPush, BuiltInFeedAdminister, BuiltInFeedDownload, ActionTemplateView, ActionTemplateCreate, ActionTemplateEdit, ActionTemplateDelete, LifecycleCreate, LifecycleView, LifecycleEdit, LifecycleDelete, AccountView, AccountEdit, AccountCreate, AccountDelete, TenantCreate, TenantEdit, TenantView, TenantDelete, TagSetCreate, TagSetEdit, TagSetDelete, TelemetryView, MachinePolicyCreate, MachinePolicyView, MachinePolicyEdit, MachinePolicyDelete, ProxyCreate, ProxyView, ProxyEdit, ProxyDelete, SubscriptionCreate, SubscriptionView, SubscriptionEdit, SubscriptionDelete, TriggerCreate, TriggerView, TriggerEdit, TriggerDelete, CertificateView, CertificateCreate, CertificateEdit, CertificateDelete, CertificateExportPrivateKey, UserEdit, ConfigureServer, FeedEdit, WorkerView, WorkerEdit, SpaceEdit, SpaceView, SpaceDelete, SpaceCreate, BuildInformationPush, BuildInformationAdminister, RunbookView, RunbookEdit, RunbookSnapshotCreate, RunbookRunView, RunbookRunDelete, RunbookRunCreate, GitCredentialView, GitCredentialEdit, EventRetentionDelete, EventRetentionView, InsightsReportView, InsightsReportCreate, InsightsReportEdit, InsightsReportDelete, DeploymentFreezeAdminister, TargetTagView, TargetTagAdminister, PlatformHubView, PlatformHubEdit, RetentionAdminister, FeatureToggleEdit, ApprovalPolicyAdminister, SshKnownHostsAdminister, SshKnownHostsView, AiAgentTranscriptView, DeployedResourceAdminister.
    • Id string
      Gets or sets a unique identifier for this resource.
    • LastModifiedBy string
      Gets or sets the username of the user who last modified this resource.
    • LastModifiedOn string
      Gets or sets the date/time that this resource was last modified. Format date-time.
    • Links object
      Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
    • Name string
    • SpacePermissionDescriptions array of string
    • SupportedRestrictions array of string
    • SystemPermissionDescriptions array of string

    Example Request

    JSON
    {
  "Description": "string",
  "GrantedSpacePermissions": [
    "AdministerSystem"
  ],
  "GrantedSystemPermissions": [
    "AdministerSystem"
  ],
  "Name": "string"
}

    Example Response

    JSON
    {
  "CanBeDeleted": true,
  "Description": "string",
  "GrantedSpacePermissions": [
    "AdministerSystem"
  ],
  "GrantedSystemPermissions": [
    "AdministerSystem"
  ],
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "SpacePermissionDescriptions": [
    "string"
  ],
  "SupportedRestrictions": [
    "string"
  ],
  "SystemPermissionDescriptions": [
    "string"
  ]
}

    Get a list of User Roles

    GET /api/userroles/all

    Lists all of the User Roles in the current Octopus Deploy instance. The results will be sorted alphabetically by name.

    Response

    200 — The requested list of user roles.

    • CanBeDeleted boolean
    • Description string
    • GrantedSpacePermissions array of enum
      Allowed values: AdministerSystem, ProjectEdit, ProjectView, ProjectCreate, ProjectDelete, ProcessView, ProcessEdit, VariableEdit, VariableEditUnscoped, VariableView, VariableViewUnscoped, ReleaseCreate, ReleaseView, ReleaseEdit, ReleaseDelete, DefectReport, DefectResolve, DeploymentCreate, DeploymentDelete, DeploymentView, EnvironmentView, EnvironmentCreate, EnvironmentEdit, EnvironmentDelete, MachineCreate, MachineEdit, MachineView, MachineDelete, ArtifactView, ArtifactCreate, ArtifactEdit, ArtifactDelete, FeedView, EventView, LibraryVariableSetView, LibraryVariableSetCreate, LibraryVariableSetEdit, LibraryVariableSetDelete, ProjectGroupView, ProjectGroupCreate, ProjectGroupEdit, ProjectGroupDelete, TeamCreate, TeamView, TeamEdit, TeamDelete, UserView, UserInvite, UserRoleView, UserRoleEdit, TaskView, TaskCreate, TaskCancel, TaskEdit, TaskPrioritize, InterruptionView, InterruptionSubmit, InterruptionViewSubmitResponsible, BuiltInFeedPush, BuiltInFeedAdminister, BuiltInFeedDownload, ActionTemplateView, ActionTemplateCreate, ActionTemplateEdit, ActionTemplateDelete, LifecycleCreate, LifecycleView, LifecycleEdit, LifecycleDelete, AccountView, AccountEdit, AccountCreate, AccountDelete, TenantCreate, TenantEdit, TenantView, TenantDelete, TagSetCreate, TagSetEdit, TagSetDelete, TelemetryView, MachinePolicyCreate, MachinePolicyView, MachinePolicyEdit, MachinePolicyDelete, ProxyCreate, ProxyView, ProxyEdit, ProxyDelete, SubscriptionCreate, SubscriptionView, SubscriptionEdit, SubscriptionDelete, TriggerCreate, TriggerView, TriggerEdit, TriggerDelete, CertificateView, CertificateCreate, CertificateEdit, CertificateDelete, CertificateExportPrivateKey, UserEdit, ConfigureServer, FeedEdit, WorkerView, WorkerEdit, SpaceEdit, SpaceView, SpaceDelete, SpaceCreate, BuildInformationPush, BuildInformationAdminister, RunbookView, RunbookEdit, RunbookSnapshotCreate, RunbookRunView, RunbookRunDelete, RunbookRunCreate, GitCredentialView, GitCredentialEdit, EventRetentionDelete, EventRetentionView, InsightsReportView, InsightsReportCreate, InsightsReportEdit, InsightsReportDelete, DeploymentFreezeAdminister, TargetTagView, TargetTagAdminister, PlatformHubView, PlatformHubEdit, RetentionAdminister, FeatureToggleEdit, ApprovalPolicyAdminister, SshKnownHostsAdminister, SshKnownHostsView, AiAgentTranscriptView, DeployedResourceAdminister.
    • GrantedSystemPermissions array of enum
      Allowed values: AdministerSystem, ProjectEdit, ProjectView, ProjectCreate, ProjectDelete, ProcessView, ProcessEdit, VariableEdit, VariableEditUnscoped, VariableView, VariableViewUnscoped, ReleaseCreate, ReleaseView, ReleaseEdit, ReleaseDelete, DefectReport, DefectResolve, DeploymentCreate, DeploymentDelete, DeploymentView, EnvironmentView, EnvironmentCreate, EnvironmentEdit, EnvironmentDelete, MachineCreate, MachineEdit, MachineView, MachineDelete, ArtifactView, ArtifactCreate, ArtifactEdit, ArtifactDelete, FeedView, EventView, LibraryVariableSetView, LibraryVariableSetCreate, LibraryVariableSetEdit, LibraryVariableSetDelete, ProjectGroupView, ProjectGroupCreate, ProjectGroupEdit, ProjectGroupDelete, TeamCreate, TeamView, TeamEdit, TeamDelete, UserView, UserInvite, UserRoleView, UserRoleEdit, TaskView, TaskCreate, TaskCancel, TaskEdit, TaskPrioritize, InterruptionView, InterruptionSubmit, InterruptionViewSubmitResponsible, BuiltInFeedPush, BuiltInFeedAdminister, BuiltInFeedDownload, ActionTemplateView, ActionTemplateCreate, ActionTemplateEdit, ActionTemplateDelete, LifecycleCreate, LifecycleView, LifecycleEdit, LifecycleDelete, AccountView, AccountEdit, AccountCreate, AccountDelete, TenantCreate, TenantEdit, TenantView, TenantDelete, TagSetCreate, TagSetEdit, TagSetDelete, TelemetryView, MachinePolicyCreate, MachinePolicyView, MachinePolicyEdit, MachinePolicyDelete, ProxyCreate, ProxyView, ProxyEdit, ProxyDelete, SubscriptionCreate, SubscriptionView, SubscriptionEdit, SubscriptionDelete, TriggerCreate, TriggerView, TriggerEdit, TriggerDelete, CertificateView, CertificateCreate, CertificateEdit, CertificateDelete, CertificateExportPrivateKey, UserEdit, ConfigureServer, FeedEdit, WorkerView, WorkerEdit, SpaceEdit, SpaceView, SpaceDelete, SpaceCreate, BuildInformationPush, BuildInformationAdminister, RunbookView, RunbookEdit, RunbookSnapshotCreate, RunbookRunView, RunbookRunDelete, RunbookRunCreate, GitCredentialView, GitCredentialEdit, EventRetentionDelete, EventRetentionView, InsightsReportView, InsightsReportCreate, InsightsReportEdit, InsightsReportDelete, DeploymentFreezeAdminister, TargetTagView, TargetTagAdminister, PlatformHubView, PlatformHubEdit, RetentionAdminister, FeatureToggleEdit, ApprovalPolicyAdminister, SshKnownHostsAdminister, SshKnownHostsView, AiAgentTranscriptView, DeployedResourceAdminister.
    • Id string
      Gets or sets a unique identifier for this resource.
    • LastModifiedBy string
      Gets or sets the username of the user who last modified this resource.
    • LastModifiedOn string
      Gets or sets the date/time that this resource was last modified. Format date-time.
    • Links object
      Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
    • Name string
    • SpacePermissionDescriptions array of string
    • SupportedRestrictions array of string
    • SystemPermissionDescriptions array of string

    Example Response

    JSON
    [
  {
    "CanBeDeleted": true,
    "Description": "string",
    "GrantedSpacePermissions": [
      "AdministerSystem"
    ],
    "GrantedSystemPermissions": [
      "AdministerSystem"
    ],
    "Id": "string",
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "Name": "string",
    "SpacePermissionDescriptions": [
      "string"
    ],
    "SupportedRestrictions": [
      "string"
    ],
    "SystemPermissionDescriptions": [
      "string"
    ]
  }
]

    Get a User Role by ID

    GET /api/userroles/{id}

    Path Parameters

    • id string (required)
      ID of the UserRole to load.

    Response

    200 — The requested user role.

    • CanBeDeleted boolean
    • Description string
    • GrantedSpacePermissions array of enum
      Allowed values: AdministerSystem, ProjectEdit, ProjectView, ProjectCreate, ProjectDelete, ProcessView, ProcessEdit, VariableEdit, VariableEditUnscoped, VariableView, VariableViewUnscoped, ReleaseCreate, ReleaseView, ReleaseEdit, ReleaseDelete, DefectReport, DefectResolve, DeploymentCreate, DeploymentDelete, DeploymentView, EnvironmentView, EnvironmentCreate, EnvironmentEdit, EnvironmentDelete, MachineCreate, MachineEdit, MachineView, MachineDelete, ArtifactView, ArtifactCreate, ArtifactEdit, ArtifactDelete, FeedView, EventView, LibraryVariableSetView, LibraryVariableSetCreate, LibraryVariableSetEdit, LibraryVariableSetDelete, ProjectGroupView, ProjectGroupCreate, ProjectGroupEdit, ProjectGroupDelete, TeamCreate, TeamView, TeamEdit, TeamDelete, UserView, UserInvite, UserRoleView, UserRoleEdit, TaskView, TaskCreate, TaskCancel, TaskEdit, TaskPrioritize, InterruptionView, InterruptionSubmit, InterruptionViewSubmitResponsible, BuiltInFeedPush, BuiltInFeedAdminister, BuiltInFeedDownload, ActionTemplateView, ActionTemplateCreate, ActionTemplateEdit, ActionTemplateDelete, LifecycleCreate, LifecycleView, LifecycleEdit, LifecycleDelete, AccountView, AccountEdit, AccountCreate, AccountDelete, TenantCreate, TenantEdit, TenantView, TenantDelete, TagSetCreate, TagSetEdit, TagSetDelete, TelemetryView, MachinePolicyCreate, MachinePolicyView, MachinePolicyEdit, MachinePolicyDelete, ProxyCreate, ProxyView, ProxyEdit, ProxyDelete, SubscriptionCreate, SubscriptionView, SubscriptionEdit, SubscriptionDelete, TriggerCreate, TriggerView, TriggerEdit, TriggerDelete, CertificateView, CertificateCreate, CertificateEdit, CertificateDelete, CertificateExportPrivateKey, UserEdit, ConfigureServer, FeedEdit, WorkerView, WorkerEdit, SpaceEdit, SpaceView, SpaceDelete, SpaceCreate, BuildInformationPush, BuildInformationAdminister, RunbookView, RunbookEdit, RunbookSnapshotCreate, RunbookRunView, RunbookRunDelete, RunbookRunCreate, GitCredentialView, GitCredentialEdit, EventRetentionDelete, EventRetentionView, InsightsReportView, InsightsReportCreate, InsightsReportEdit, InsightsReportDelete, DeploymentFreezeAdminister, TargetTagView, TargetTagAdminister, PlatformHubView, PlatformHubEdit, RetentionAdminister, FeatureToggleEdit, ApprovalPolicyAdminister, SshKnownHostsAdminister, SshKnownHostsView, AiAgentTranscriptView, DeployedResourceAdminister.
    • GrantedSystemPermissions array of enum
      Allowed values: AdministerSystem, ProjectEdit, ProjectView, ProjectCreate, ProjectDelete, ProcessView, ProcessEdit, VariableEdit, VariableEditUnscoped, VariableView, VariableViewUnscoped, ReleaseCreate, ReleaseView, ReleaseEdit, ReleaseDelete, DefectReport, DefectResolve, DeploymentCreate, DeploymentDelete, DeploymentView, EnvironmentView, EnvironmentCreate, EnvironmentEdit, EnvironmentDelete, MachineCreate, MachineEdit, MachineView, MachineDelete, ArtifactView, ArtifactCreate, ArtifactEdit, ArtifactDelete, FeedView, EventView, LibraryVariableSetView, LibraryVariableSetCreate, LibraryVariableSetEdit, LibraryVariableSetDelete, ProjectGroupView, ProjectGroupCreate, ProjectGroupEdit, ProjectGroupDelete, TeamCreate, TeamView, TeamEdit, TeamDelete, UserView, UserInvite, UserRoleView, UserRoleEdit, TaskView, TaskCreate, TaskCancel, TaskEdit, TaskPrioritize, InterruptionView, InterruptionSubmit, InterruptionViewSubmitResponsible, BuiltInFeedPush, BuiltInFeedAdminister, BuiltInFeedDownload, ActionTemplateView, ActionTemplateCreate, ActionTemplateEdit, ActionTemplateDelete, LifecycleCreate, LifecycleView, LifecycleEdit, LifecycleDelete, AccountView, AccountEdit, AccountCreate, AccountDelete, TenantCreate, TenantEdit, TenantView, TenantDelete, TagSetCreate, TagSetEdit, TagSetDelete, TelemetryView, MachinePolicyCreate, MachinePolicyView, MachinePolicyEdit, MachinePolicyDelete, ProxyCreate, ProxyView, ProxyEdit, ProxyDelete, SubscriptionCreate, SubscriptionView, SubscriptionEdit, SubscriptionDelete, TriggerCreate, TriggerView, TriggerEdit, TriggerDelete, CertificateView, CertificateCreate, CertificateEdit, CertificateDelete, CertificateExportPrivateKey, UserEdit, ConfigureServer, FeedEdit, WorkerView, WorkerEdit, SpaceEdit, SpaceView, SpaceDelete, SpaceCreate, BuildInformationPush, BuildInformationAdminister, RunbookView, RunbookEdit, RunbookSnapshotCreate, RunbookRunView, RunbookRunDelete, RunbookRunCreate, GitCredentialView, GitCredentialEdit, EventRetentionDelete, EventRetentionView, InsightsReportView, InsightsReportCreate, InsightsReportEdit, InsightsReportDelete, DeploymentFreezeAdminister, TargetTagView, TargetTagAdminister, PlatformHubView, PlatformHubEdit, RetentionAdminister, FeatureToggleEdit, ApprovalPolicyAdminister, SshKnownHostsAdminister, SshKnownHostsView, AiAgentTranscriptView, DeployedResourceAdminister.
    • Id string
      Gets or sets a unique identifier for this resource.
    • LastModifiedBy string
      Gets or sets the username of the user who last modified this resource.
    • LastModifiedOn string
      Gets or sets the date/time that this resource was last modified. Format date-time.
    • Links object
      Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
    • Name string
    • SpacePermissionDescriptions array of string
    • SupportedRestrictions array of string
    • SystemPermissionDescriptions array of string

    Example Response

    JSON
    {
  "CanBeDeleted": true,
  "Description": "string",
  "GrantedSpacePermissions": [
    "AdministerSystem"
  ],
  "GrantedSystemPermissions": [
    "AdministerSystem"
  ],
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "SpacePermissionDescriptions": [
    "string"
  ],
  "SupportedRestrictions": [
    "string"
  ],
  "SystemPermissionDescriptions": [
    "string"
  ]
}

    Modify an existing User Role

    PUT /api/userroles/{id}

    Path Parameters

    • id string (required)
      Id of the User Role to modify.

    Request Body

    • Description string
    • GrantedSpacePermissions array of enum
      Allowed values: AdministerSystem, ProjectEdit, ProjectView, ProjectCreate, ProjectDelete, ProcessView, ProcessEdit, VariableEdit, VariableEditUnscoped, VariableView, VariableViewUnscoped, ReleaseCreate, ReleaseView, ReleaseEdit, ReleaseDelete, DefectReport, DefectResolve, DeploymentCreate, DeploymentDelete, DeploymentView, EnvironmentView, EnvironmentCreate, EnvironmentEdit, EnvironmentDelete, MachineCreate, MachineEdit, MachineView, MachineDelete, ArtifactView, ArtifactCreate, ArtifactEdit, ArtifactDelete, FeedView, EventView, LibraryVariableSetView, LibraryVariableSetCreate, LibraryVariableSetEdit, LibraryVariableSetDelete, ProjectGroupView, ProjectGroupCreate, ProjectGroupEdit, ProjectGroupDelete, TeamCreate, TeamView, TeamEdit, TeamDelete, UserView, UserInvite, UserRoleView, UserRoleEdit, TaskView, TaskCreate, TaskCancel, TaskEdit, TaskPrioritize, InterruptionView, InterruptionSubmit, InterruptionViewSubmitResponsible, BuiltInFeedPush, BuiltInFeedAdminister, BuiltInFeedDownload, ActionTemplateView, ActionTemplateCreate, ActionTemplateEdit, ActionTemplateDelete, LifecycleCreate, LifecycleView, LifecycleEdit, LifecycleDelete, AccountView, AccountEdit, AccountCreate, AccountDelete, TenantCreate, TenantEdit, TenantView, TenantDelete, TagSetCreate, TagSetEdit, TagSetDelete, TelemetryView, MachinePolicyCreate, MachinePolicyView, MachinePolicyEdit, MachinePolicyDelete, ProxyCreate, ProxyView, ProxyEdit, ProxyDelete, SubscriptionCreate, SubscriptionView, SubscriptionEdit, SubscriptionDelete, TriggerCreate, TriggerView, TriggerEdit, TriggerDelete, CertificateView, CertificateCreate, CertificateEdit, CertificateDelete, CertificateExportPrivateKey, UserEdit, ConfigureServer, FeedEdit, WorkerView, WorkerEdit, SpaceEdit, SpaceView, SpaceDelete, SpaceCreate, BuildInformationPush, BuildInformationAdminister, RunbookView, RunbookEdit, RunbookSnapshotCreate, RunbookRunView, RunbookRunDelete, RunbookRunCreate, GitCredentialView, GitCredentialEdit, EventRetentionDelete, EventRetentionView, InsightsReportView, InsightsReportCreate, InsightsReportEdit, InsightsReportDelete, DeploymentFreezeAdminister, TargetTagView, TargetTagAdminister, PlatformHubView, PlatformHubEdit, RetentionAdminister, FeatureToggleEdit, ApprovalPolicyAdminister, SshKnownHostsAdminister, SshKnownHostsView, AiAgentTranscriptView, DeployedResourceAdminister.
    • GrantedSystemPermissions array of enum
      Allowed values: AdministerSystem, ProjectEdit, ProjectView, ProjectCreate, ProjectDelete, ProcessView, ProcessEdit, VariableEdit, VariableEditUnscoped, VariableView, VariableViewUnscoped, ReleaseCreate, ReleaseView, ReleaseEdit, ReleaseDelete, DefectReport, DefectResolve, DeploymentCreate, DeploymentDelete, DeploymentView, EnvironmentView, EnvironmentCreate, EnvironmentEdit, EnvironmentDelete, MachineCreate, MachineEdit, MachineView, MachineDelete, ArtifactView, ArtifactCreate, ArtifactEdit, ArtifactDelete, FeedView, EventView, LibraryVariableSetView, LibraryVariableSetCreate, LibraryVariableSetEdit, LibraryVariableSetDelete, ProjectGroupView, ProjectGroupCreate, ProjectGroupEdit, ProjectGroupDelete, TeamCreate, TeamView, TeamEdit, TeamDelete, UserView, UserInvite, UserRoleView, UserRoleEdit, TaskView, TaskCreate, TaskCancel, TaskEdit, TaskPrioritize, InterruptionView, InterruptionSubmit, InterruptionViewSubmitResponsible, BuiltInFeedPush, BuiltInFeedAdminister, BuiltInFeedDownload, ActionTemplateView, ActionTemplateCreate, ActionTemplateEdit, ActionTemplateDelete, LifecycleCreate, LifecycleView, LifecycleEdit, LifecycleDelete, AccountView, AccountEdit, AccountCreate, AccountDelete, TenantCreate, TenantEdit, TenantView, TenantDelete, TagSetCreate, TagSetEdit, TagSetDelete, TelemetryView, MachinePolicyCreate, MachinePolicyView, MachinePolicyEdit, MachinePolicyDelete, ProxyCreate, ProxyView, ProxyEdit, ProxyDelete, SubscriptionCreate, SubscriptionView, SubscriptionEdit, SubscriptionDelete, TriggerCreate, TriggerView, TriggerEdit, TriggerDelete, CertificateView, CertificateCreate, CertificateEdit, CertificateDelete, CertificateExportPrivateKey, UserEdit, ConfigureServer, FeedEdit, WorkerView, WorkerEdit, SpaceEdit, SpaceView, SpaceDelete, SpaceCreate, BuildInformationPush, BuildInformationAdminister, RunbookView, RunbookEdit, RunbookSnapshotCreate, RunbookRunView, RunbookRunDelete, RunbookRunCreate, GitCredentialView, GitCredentialEdit, EventRetentionDelete, EventRetentionView, InsightsReportView, InsightsReportCreate, InsightsReportEdit, InsightsReportDelete, DeploymentFreezeAdminister, TargetTagView, TargetTagAdminister, PlatformHubView, PlatformHubEdit, RetentionAdminister, FeatureToggleEdit, ApprovalPolicyAdminister, SshKnownHostsAdminister, SshKnownHostsView, AiAgentTranscriptView, DeployedResourceAdminister.
    • Id string (required)
      Id of the User Role to modify.
    • Name string

    Response

    200 — Successful modify operation.

    • CanBeDeleted boolean
    • Description string
    • GrantedSpacePermissions array of enum
      Allowed values: AdministerSystem, ProjectEdit, ProjectView, ProjectCreate, ProjectDelete, ProcessView, ProcessEdit, VariableEdit, VariableEditUnscoped, VariableView, VariableViewUnscoped, ReleaseCreate, ReleaseView, ReleaseEdit, ReleaseDelete, DefectReport, DefectResolve, DeploymentCreate, DeploymentDelete, DeploymentView, EnvironmentView, EnvironmentCreate, EnvironmentEdit, EnvironmentDelete, MachineCreate, MachineEdit, MachineView, MachineDelete, ArtifactView, ArtifactCreate, ArtifactEdit, ArtifactDelete, FeedView, EventView, LibraryVariableSetView, LibraryVariableSetCreate, LibraryVariableSetEdit, LibraryVariableSetDelete, ProjectGroupView, ProjectGroupCreate, ProjectGroupEdit, ProjectGroupDelete, TeamCreate, TeamView, TeamEdit, TeamDelete, UserView, UserInvite, UserRoleView, UserRoleEdit, TaskView, TaskCreate, TaskCancel, TaskEdit, TaskPrioritize, InterruptionView, InterruptionSubmit, InterruptionViewSubmitResponsible, BuiltInFeedPush, BuiltInFeedAdminister, BuiltInFeedDownload, ActionTemplateView, ActionTemplateCreate, ActionTemplateEdit, ActionTemplateDelete, LifecycleCreate, LifecycleView, LifecycleEdit, LifecycleDelete, AccountView, AccountEdit, AccountCreate, AccountDelete, TenantCreate, TenantEdit, TenantView, TenantDelete, TagSetCreate, TagSetEdit, TagSetDelete, TelemetryView, MachinePolicyCreate, MachinePolicyView, MachinePolicyEdit, MachinePolicyDelete, ProxyCreate, ProxyView, ProxyEdit, ProxyDelete, SubscriptionCreate, SubscriptionView, SubscriptionEdit, SubscriptionDelete, TriggerCreate, TriggerView, TriggerEdit, TriggerDelete, CertificateView, CertificateCreate, CertificateEdit, CertificateDelete, CertificateExportPrivateKey, UserEdit, ConfigureServer, FeedEdit, WorkerView, WorkerEdit, SpaceEdit, SpaceView, SpaceDelete, SpaceCreate, BuildInformationPush, BuildInformationAdminister, RunbookView, RunbookEdit, RunbookSnapshotCreate, RunbookRunView, RunbookRunDelete, RunbookRunCreate, GitCredentialView, GitCredentialEdit, EventRetentionDelete, EventRetentionView, InsightsReportView, InsightsReportCreate, InsightsReportEdit, InsightsReportDelete, DeploymentFreezeAdminister, TargetTagView, TargetTagAdminister, PlatformHubView, PlatformHubEdit, RetentionAdminister, FeatureToggleEdit, ApprovalPolicyAdminister, SshKnownHostsAdminister, SshKnownHostsView, AiAgentTranscriptView, DeployedResourceAdminister.
    • GrantedSystemPermissions array of enum
      Allowed values: AdministerSystem, ProjectEdit, ProjectView, ProjectCreate, ProjectDelete, ProcessView, ProcessEdit, VariableEdit, VariableEditUnscoped, VariableView, VariableViewUnscoped, ReleaseCreate, ReleaseView, ReleaseEdit, ReleaseDelete, DefectReport, DefectResolve, DeploymentCreate, DeploymentDelete, DeploymentView, EnvironmentView, EnvironmentCreate, EnvironmentEdit, EnvironmentDelete, MachineCreate, MachineEdit, MachineView, MachineDelete, ArtifactView, ArtifactCreate, ArtifactEdit, ArtifactDelete, FeedView, EventView, LibraryVariableSetView, LibraryVariableSetCreate, LibraryVariableSetEdit, LibraryVariableSetDelete, ProjectGroupView, ProjectGroupCreate, ProjectGroupEdit, ProjectGroupDelete, TeamCreate, TeamView, TeamEdit, TeamDelete, UserView, UserInvite, UserRoleView, UserRoleEdit, TaskView, TaskCreate, TaskCancel, TaskEdit, TaskPrioritize, InterruptionView, InterruptionSubmit, InterruptionViewSubmitResponsible, BuiltInFeedPush, BuiltInFeedAdminister, BuiltInFeedDownload, ActionTemplateView, ActionTemplateCreate, ActionTemplateEdit, ActionTemplateDelete, LifecycleCreate, LifecycleView, LifecycleEdit, LifecycleDelete, AccountView, AccountEdit, AccountCreate, AccountDelete, TenantCreate, TenantEdit, TenantView, TenantDelete, TagSetCreate, TagSetEdit, TagSetDelete, TelemetryView, MachinePolicyCreate, MachinePolicyView, MachinePolicyEdit, MachinePolicyDelete, ProxyCreate, ProxyView, ProxyEdit, ProxyDelete, SubscriptionCreate, SubscriptionView, SubscriptionEdit, SubscriptionDelete, TriggerCreate, TriggerView, TriggerEdit, TriggerDelete, CertificateView, CertificateCreate, CertificateEdit, CertificateDelete, CertificateExportPrivateKey, UserEdit, ConfigureServer, FeedEdit, WorkerView, WorkerEdit, SpaceEdit, SpaceView, SpaceDelete, SpaceCreate, BuildInformationPush, BuildInformationAdminister, RunbookView, RunbookEdit, RunbookSnapshotCreate, RunbookRunView, RunbookRunDelete, RunbookRunCreate, GitCredentialView, GitCredentialEdit, EventRetentionDelete, EventRetentionView, InsightsReportView, InsightsReportCreate, InsightsReportEdit, InsightsReportDelete, DeploymentFreezeAdminister, TargetTagView, TargetTagAdminister, PlatformHubView, PlatformHubEdit, RetentionAdminister, FeatureToggleEdit, ApprovalPolicyAdminister, SshKnownHostsAdminister, SshKnownHostsView, AiAgentTranscriptView, DeployedResourceAdminister.
    • Id string
      Gets or sets a unique identifier for this resource.
    • LastModifiedBy string
      Gets or sets the username of the user who last modified this resource.
    • LastModifiedOn string
      Gets or sets the date/time that this resource was last modified. Format date-time.
    • Links object
      Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
    • Name string
    • SpacePermissionDescriptions array of string
    • SupportedRestrictions array of string
    • SystemPermissionDescriptions array of string

    Example Request

    JSON
    {
  "Description": "string",
  "GrantedSpacePermissions": [
    "AdministerSystem"
  ],
  "GrantedSystemPermissions": [
    "AdministerSystem"
  ],
  "Id": "string",
  "Name": "string"
}

    Example Response

    JSON
    {
  "CanBeDeleted": true,
  "Description": "string",
  "GrantedSpacePermissions": [
    "AdministerSystem"
  ],
  "GrantedSystemPermissions": [
    "AdministerSystem"
  ],
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "SpacePermissionDescriptions": [
    "string"
  ],
  "SupportedRestrictions": [
    "string"
  ],
  "SystemPermissionDescriptions": [
    "string"
  ]
}

    Delete an existing User Role

    DELETE /api/userroles/{id}

    Path Parameters

    • id string (required)
      ID of the User Role to delete.

    Response

    200 — Success

    Navigate Select Esc Close