Download OpenAPI specification:Download
This is the spec that defines the API provided by the application to validate authorization for the passed role
Validates authorization for the role
roles required | Array of strings non-empty unique 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 |
{- "code": 0,
- "message": "message"
}
Get specific role defined in EFA
role_name required | string Name of the role to be queried |
{- "role-name": "SecurityAdmin",
- "description": "Performs user management, PKI and key management operations in the system"
}
Get all roles defined in EFA
include_internal | boolean To include the internal roles in the response |
{- "role-list": "{role-list:[{role-name:FabricAdmin,description:Registers devices to fabric...},{role-name:SecurityAdmin,description:Performs user management, PKI and key management operations in the system.}...}]}"
}
Validates tenant authorization for the role
roles required | Array of strings non-empty unique 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 |
{- "code": 0,
- "message": "message"
}
Get list of all tenants authorized for the given dynamic role. For static roles, the list will be empty.
roles required | Array of strings non-empty unique One or more role names passed from the northbound API |
"{accessible: specific, tenants:[{tenant-one, tenant-two}]}"
Get the detailed output of the given execution ID
id required | string Detailed output of the given execution ID |
{- "start_time": "2000-01-23T04:56:07.000+00:00",
- "end_time": "2000-01-23T04:56:07.000+00:00",
- "id": "id",
- "parameters": "configure add",
- "logs": "logs",
- "command": "configure add",
- "status": "Failed, Succeeded"
}
This API will delete the execution entries older than specific number of days
days_older_by required | integer Default: 30 Deletes execution entries older than specified number of days |
{- "code": 0,
- "message": "message"
}
Get the list of all the previous executions
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) |
{- "items": [
- {
- "start_time": "2000-01-23T04:56:07.000+00:00",
- "end_time": "2000-01-23T04:56:07.000+00:00",
- "id": "id",
- "command": "configure add",
- "status": "configure add"
}, - {
- "start_time": "2000-01-23T04:56:07.000+00:00",
- "end_time": "2000-01-23T04:56:07.000+00:00",
- "id": "id",
- "command": "configure add",
- "status": "configure add"
}
]
}