Roles / Actions: Deprecate

Description

Deprecate a Role and set another Role to replace it.

HTTP Request

POST /api/v1beta0/user/envId/roles/roleId/actions/deprecate/

Parameters

Name Required Description Location
envId
integer		 Yes

The ID of the Environment scoping this request.

 path
roleId
integer		 Yes

The ID of a Role object.

 path

Request body (optional)

Deprecate Role options.

Example value: 

{
  "deprecate": true,
  "replacement": {
    "id": 1
  }
}

Fields description:

Name Required Description
deprecate
boolean		 No

By default deprecate Role If a value is true clears the deprecate from Role.
replacement
RoleForeignKey		 No

The suggested replacement Role foreign key for the current Role.

Successful Response (Status 200)

The JSON representation of a Role object.

The API replies with a RoleDetailsResponse object. Example response body: 

{
  "data": {
    "builtinAutomation": [
      "base"
    ],
    "category": {
      "id": 1
    },
    "deprecated": {
      "deprecated": "2013-01-01T12:34:56.789Z",
      "replacement": {
        "id": 1
      }
    },
    "description": "string",
    "id": 1,
    "name": "string",
    "os": {
      "id": "string"
    },
    "quickStart": true,
    "quickStartGroup": "string",
    "scope": "scalr",
    "tags": [
      "string"
    ],
    "useScalrAgent": true
  },
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "meta": {
    "sample": "string"
  },
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Other Response Messages

HTTP Status Code Reason Response Model
400

A client-side error was made.

 An ApiErrorResponse object
401

The request was not authenticated.

 An ApiErrorResponse object
403

Insufficient permissions.

 An ApiErrorResponse object
404

Resource not found.

 An ApiErrorResponse object
409

Conflict with current state.

 An ApiErrorResponse object
422

This request was well-formed but was rejected due to semantic errors.

 An ApiErrorResponse object
500

A server-side error occurred.

 An ApiErrorResponse object
501

This feature is not implemented in Scalr.

 An ApiErrorResponse object
503

The service is currently unavailable.

 An ApiErrorResponse object

Try it out!

Parameter Value Description
envId

The ID of the Environment scoping this request.
roleId

The ID of a Role object.
body
optional

Deprecate Role options.