Jump to

• Request
• Response

Copy Role

post

/role/copyRole

Copies a Role structure and places it under a Role Object specified by ParentRoleObjectId.

Request

Header Parameters

• Authorization: string
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : CopyRole

Type: object

Title: CopyRole

CopyRole Entity

Show Source

• CopyChildRoles: boolean
• CopyCodes: boolean
• CopyResources: boolean
• ParentRoleObjectId: string
  The unique identifier of an existing role that will contain the copied role
• RoleObjectId: string
  The unique identifier of the source Role structure to copy.

{
    "title":"CopyRole",
    "type":"object",
    "properties":{
        "RoleObjectId":{
            "type":"string",
            "description":"The unique identifier of the source Role structure to copy.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ParentRoleObjectId":{
            "type":"string",
            "description":"The unique identifier of an existing role that will contain the copied role",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "CopyChildRoles":{
            "type":"boolean",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "CopyResources":{
            "type":"boolean",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "CopyCodes":{
            "type":"boolean",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "description":"CopyRole Entity",
    "exampleSetFlag":false
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

OK

Body ()

Root Schema : CopyRoleResponse

Type: object

Title: CopyRoleResponse

CopyRoleResponse Entity

Show Source

• ParentRoleObjectId: string
• RoleObjectId: array RoleObjectId
• Success: boolean

{
    "title":"CopyRoleResponse",
    "type":"object",
    "properties":{
        "Success":{
            "type":"boolean",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "RoleObjectId":{
            "type":"array",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "ParentRoleObjectId":{
            "type":"string",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"CopyRoleResponse Entity",
    "exampleSetFlag":false
}

Nested Schema : RoleObjectId

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top