Altair SLC Hub Access Controller (2024.0.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

Queries current role instances

Authorizations:

bearerAuth

query Parameters

filter[name][EQ]	string
filter[name][CO]	string
filter[system][EQ]	boolean
filter[created][LT]	string <date-time>
filter[created][GT]	string <date-time>
filter[modified][LT]	string <date-time>
filter[modified][GT]	string <date-time>
page[offset]	integer
page[limit]	integer
sort	string Enum: "name" "-name" "created" "-created" "modified" "-modified"

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"data": [{"id": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"permissions": [{"object": "string",
"objectMatcher": "simple",
"actions": ["string"
],
"effect": "Allow"
}
],
"system": true
}
]
}

createRole

Creates a new role entity

Authorizations:

bearerAuth

Request Body schema: application/json

id	string
created	string <date-time>
modified	string <date-time>
name required	string
description	string
	Array of objects (permission)
system	boolean

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"permissions": [{"object": "string",
"objectMatcher": "simple",
"actions": ["string"
],
"effect": "Allow"
}
],
"system": true
}

Response samples

202
409

Content type

application/json

{"id": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"permissions": [{"object": "string",
"objectMatcher": "simple",
"actions": ["string"
],
"effect": "Allow"
}
],
"system": true
}

nameAvailability

Authorizations:

bearerAuth

query Parameters

name

required

string

Responses

Response samples

200

Content type

application/json

{"result": true,
"reason": "invalid",
"msg": "string"
}

Returns a specific role entity by ID

Authorizations:

bearerAuth

path Parameters

roleId

required

string

ID of the role

Responses

Response samples

200
404

Content type

application/json

{"id": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"permissions": [{"object": "string",
"objectMatcher": "simple",
"actions": ["string"
],
"effect": "Allow"
}
],
"system": true
}

Updates the definition of a role

Authorizations:

bearerAuth

path Parameters

roleId

required

string

ID of the role

Request Body schema: application/json

id	string
created	string <date-time>
modified	string <date-time>
name required	string
description	string
	Array of objects (permission)
system	boolean

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"permissions": [{"object": "string",
"objectMatcher": "simple",
"actions": ["string"
],
"effect": "Allow"
}
],
"system": true
}

Response samples

200
404
409

Content type

application/json

{"id": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"permissions": [{"object": "string",
"objectMatcher": "simple",
"actions": ["string"
],
"effect": "Allow"
}
],
"system": true
}

Updates the definition of a role using JSON Patch

Authorizations:

bearerAuth

path Parameters

roleId

required

string

ID of the role

Request Body schema: application/json-patch+json

Array ()

op required	string Enum: "add" "remove" "replace" The operation to be performed
path required	string A JSON-Pointer
value	any The value to be used within the operations.

Responses

Request samples

Payload

Content type

application/json-patch+json

[{"op": "add",
"path": "string",
"value": null
}
]

Response samples

200
404
409

Content type

application/json

{"id": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"permissions": [{"object": "string",
"objectMatcher": "simple",
"actions": ["string"
],
"effect": "Allow"
}
],
"system": true
}

Deletes a specific role by ID

Authorizations:

bearerAuth

path Parameters

roleId

required

string

ID of the role

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

Queries current role bindings

Authorizations:

bearerAuth

query Parameters

filter[role][EQ]	string filter by the ID of the role
filter[principal][EQ]	string filter by the ID of the principal
filter[principal][IN]	string filter by the ID of the principal matching one of a comma separated list
page[offset]	integer
page[limit]	integer
sort	string Enum: "role" "-role" "principal" "-principal" "created" "-created"

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "string",
"created": "2019-08-24T14:15:22Z",
"role": "string",
"principal": "string",
"namespace": "string"
}
],
"totalCount": 0,
"roles": {"property1": "string",
"property2": "string"
}
}

createRoleBinding

Creates a new role binding

Authorizations:

bearerAuth

Request Body schema: application/json

id	string
created	string <date-time>
role required	string
principal required	string
namespace required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"created": "2019-08-24T14:15:22Z",
"role": "string",
"principal": "string",
"namespace": "string"
}

Response samples

202
409

Content type

application/json

{"id": "string",
"created": "2019-08-24T14:15:22Z",
"role": "string",
"principal": "string",
"namespace": "string"
}

Deletes role bindings

Authorizations:

bearerAuth

query Parameters

filter[role][EQ]	string deletes by the ID of the role
filter[namespace][EQ]	string deletes by the namespace of the binding
filter[principal][EQ]	string deletes by the ID of the principal

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Deletes a specific role binding by ID

Authorizations:

bearerAuth

path Parameters

roleBindingId

required

string

ID of the role binding

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

evaluateAccessControl

Evaluates access control for the current user

Authorizations:

bearerAuth

Request Body schema: application/json

Array ()

object required	string
action required	string
namespace	string

Responses

Request samples

Payload

Content type

application/json

[{"object": "string",
"action": "string",
"namespace": "string"
}
]

Response samples

200

Content type

application/json

["Allow"
]

explainAccessControl

Evaluates access control for the given user and returns an explanation of the result

Authorizations:

bearerAuth

Request Body schema: application/json

Array ()

user required	string
groups	Array of strings
object required	string
action required	string
namespace	string

Responses

Request samples

Payload

Content type

application/json

[{"user": "string",
"groups": ["string"
],
"object": "string",
"action": "string",
"namespace": "string"
}
]

Response samples

200

Content type

application/json

[{"effect": "Allow",
"explanation": [{"matches": true,
"source": "string",
"effect": "Allow"
}
]
}
]

queryDecisionLog

Authorizations:

bearerAuth

query Parameters

filter[userId][EQ]	string
filter[object][EQ]	string
filter[object][SW]	string
filter[action][EQ]	string
filter[namespace][EQ]	string
filter[decision][EQ]	string (effect) Enum: "Allow" "Deny"
filter[purpose][EQ]	string (purpose) Enum: "Request" "Filter"
filter[when][LT]	string <date-time>
filter[when][GT]	string <date-time>
page[limit]	integer
page[offset]	integer
sort	string Enum: "object" "-object" "when" "-when"

Responses

Response samples

200

Content type

application/json

[{"object": "string",
"namespace": "string",
"action": "string",
"userId": "string",
"groups": ["string"
],
"decision": "Allow",
"purpose": "Request",
"when": "2019-08-24T14:15:22Z"
}
]

queryDecisionLogDistinct

Authorizations:

bearerAuth

query Parameters

filter[value][SW]	string
page[limit]	integer
page[offset]	integer
field	string Enum: "object" "action"

Responses

Response samples

200

Content type

application/json

["string"
]