RBAC Service (2.2.0)

Download OpenAPI specification:Download

This is the spec that defines the API provided by the application to validate authorization for the passed role

RBAC

Validate authorization

Validates authorization for the role

query Parameters
roles
required
Array of strings non-empty

One or more role names passed from the northbound API

method
required
string

Method passed from the northbound API

path
required
string

Path passed from the northbound API

Responses

200

OK

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error

get/rbac/isauthorized
http://gorbac-service:80/v1/rbac/isauthorized

Get Role

Get specific role defined in EFA

query Parameters
role_name
required
string

Name of the role to be queried

Responses

200

OK

401

Authorization information is missing or invalid.

500

Unexpected error

default

Unexpected error

get/rbac/role
http://gorbac-service:80/v1/rbac/role

Get Roles

Get all roles defined in EFA

Responses

200

OK

401

Authorization information is missing or invalid.

500

Unexpected error

default

Unexpected error

get/rbac/roles
http://gorbac-service:80/v1/rbac/roles

RBAC-Tenant

Validate authorization for tenant

Validates tenant authorization for the role

query Parameters
roles
required
Array of strings non-empty

One or more role names passed from the northbound API

tenant-name
string

Tenant name passed from the northbound API

method
required
string

Method passed from the northbound API

path
required
string

Path passed from the northbound API

Responses

200

OK

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error

get/rbac/tenant/isauthorized
http://gorbac-service:80/v1/rbac/tenant/isauthorized

Trouble Shooting

getExecutionDetail

Get the detailed output of the given execution ID

query Parameters
id
required
string

Detailed output of the given execution ID

Responses

200

OK

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error

get/rbac/execution
http://gorbac-service:80/v1/rbac/execution

deleteExecutions

This API will delete the execution entries older than specific number of days

query Parameters
days_older_by
required
integer
Default: 30

Deletes execution entries older than specified number of days

Responses

200

OK

202

ACCEPTED

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error

delete/rbac/execution
http://gorbac-service:80/v1/rbac/execution

getExecutionList

Get the list of all the previous executions

query Parameters
limit
required
integer
Default: 10

Limit the number of executions that will be sent in the response. Default is 10

status
string
Default: "all"

Filter the executions based on the status(failed/succeeded/all)

Responses

200

OK

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error

get/rbac/executions
http://gorbac-service:80/v1/rbac/executions