Jump to

• Request
• Response

Create a Role

post

/process/api/v1/data-access/roles

Creates a new role.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : Role

Type: object

Title: Role

Defines Role

Show Source

• createdOn: string
  Title: Created time

  Created time
• description: string
  Title: The role description

  Tho role description
• id: string
  Title: The role ID

  The unique role ID
• links: array links
• name(required): string
  Title: The role name

  The unique role name
• scopeName: string
  Title: Scope Name

  The role scope name
• scopeType: string
  Title: Scope Type

  The role scope type
• systemDefined: boolean
  Title: System Defined Role

  Default Value: false

  If boolean flag is true, then the Role cannot be deleted. By default it's false.
• updatedOn: string
  Title: Updated time

  Updated time

{
    "type":"object",
    "title":"Role",
    "description":"Defines Role",
    "additionalProperties":false,
    "required":[
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "title":"The role ID",
            "description":"The unique role ID"
        },
        "name":{
            "type":"string",
            "title":"The role name",
            "description":"The unique role name"
        },
        "description":{
            "type":"string",
            "title":"The role description",
            "description":"Tho role description"
        },
        "scopeType":{
            "type":"string",
            "title":"Scope Type",
            "description":"The role scope type"
        },
        "scopeName":{
            "type":"string",
            "title":"Scope Name",
            "description":"The role scope name"
        },
        "systemDefined":{
            "type":"boolean",
            "default":false,
            "title":"System Defined Role",
            "description":"If boolean flag is true, then the Role cannot be deleted. By default it's false."
        },
        "createdOn":{
            "type":"string",
            "title":"Created time",
            "description":"Created time"
        },
        "updatedOn":{
            "type":"string",
            "title":"Updated time",
            "description":"Updated time"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Defines Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Defines Link

Show Source

• code: integer
  Minimum Value: 100

  Maximum Value: 600
• href(required): string
• hreflang: string
• length: integer (int32)
• mediaType: string
• message: string
• rel(required): string
• title: string
• type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":100,
            "maximum":600
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created

Body ()

Root Schema : Role

Type: object

Title: Role

Defines Role

Show Source

• createdOn: string
  Title: Created time

  Created time
• description: string
  Title: The role description

  Tho role description
• id: string
  Title: The role ID

  The unique role ID
• links: array links
• name(required): string
  Title: The role name

  The unique role name
• scopeName: string
  Title: Scope Name

  The role scope name
• scopeType: string
  Title: Scope Type

  The role scope type
• systemDefined: boolean
  Title: System Defined Role

  Default Value: false

  If boolean flag is true, then the Role cannot be deleted. By default it's false.
• updatedOn: string
  Title: Updated time

  Updated time

{
    "type":"object",
    "title":"Role",
    "description":"Defines Role",
    "additionalProperties":false,
    "required":[
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "title":"The role ID",
            "description":"The unique role ID"
        },
        "name":{
            "type":"string",
            "title":"The role name",
            "description":"The unique role name"
        },
        "description":{
            "type":"string",
            "title":"The role description",
            "description":"Tho role description"
        },
        "scopeType":{
            "type":"string",
            "title":"Scope Type",
            "description":"The role scope type"
        },
        "scopeName":{
            "type":"string",
            "title":"Scope Name",
            "description":"The role scope name"
        },
        "systemDefined":{
            "type":"boolean",
            "default":false,
            "title":"System Defined Role",
            "description":"If boolean flag is true, then the Role cannot be deleted. By default it's false."
        },
        "createdOn":{
            "type":"string",
            "title":"Created time",
            "description":"Created time"
        },
        "updatedOn":{
            "type":"string",
            "title":"Updated time",
            "description":"Updated time"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Defines Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Defines Link

Show Source

• code: integer
  Minimum Value: 100

  Maximum Value: 600
• href(required): string
• hreflang: string
• length: integer (int32)
• mediaType: string
• message: string
• rel(required): string
• title: string
• type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":100,
            "maximum":600
        }
    }
}

400 Response

Bad request

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

409 Response

Conflict

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

429 Response

Too many requests

500 Response

Internal server error

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

503 Response

Too many exceptions or too slow requests

Back to Top