ScopedUserRoles

Modify a scoped user role.

put/{spaceId}/scopeduserroles/{id}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/scopeduserroles/{id}
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdstring required
idstring required

The ID of the scoped user role to modify.

Request body

EnvironmentIdsstring[]
Idstring required

The ID of the scoped user role to modify.

ProjectGroupIdsstring[]
ProjectIdsstring[]
SpaceIdstring
TeamIdstring required
TenantIdsstring[]
UserRoleIdstring required

Example request

{
  "EnvironmentIds": [
    "Environments-1",
    "..."
  ],
  "ProjectGroupIds": [
    "ProjectGroups-1",
    "..."
  ],
  "ProjectIds": [
    "Projects-1",
    "..."
  ],
  "SpaceId": "Spaces-1",
  "TenantIds": [
    "Tenants-1",
    "..."
  ]
}

Response

Confirmation that the Scoped User Role was modified, containing the updated Role

EnvironmentIdsstring[]
Idstring

Gets or sets a unique identifier for this resource.

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

ProjectGroupIdsstring[]
ProjectIdsstring[]
SpaceIdstring
TeamIdstring
TenantIdsstring[]
UserRoleIdstring

Example response

{
  "EnvironmentIds": [
    "Environments-1",
    "..."
  ],
  "Links": {
    "Self": "/api/..."
  },
  "ProjectIds": [
    "Projects-1",
    "..."
  ],
  "SpaceId": "Spaces-1",
  "TenantIds": [
    "Tenants-1",
    "..."
  ]
}

Changes