Altair SLC Hub Auth Domains (2024.0.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

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

queryAuthDomains

Authorizations:

bearerAuth

query Parameters

filter[namespace][EQ]	string
filter[namespace][IN]	Array of strings
filter[name][EQ]	string
filter[name][CO]	string
filter[name][SW]	string
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",
"namespace": "string",
"description": "string",
"allowPersonalCredentials": true
}
]
}

createAuthDomain

Authorizations:

bearerAuth

Request Body schema: application/json

_id	string
_created	string <date-time>
_modified	string <date-time>
name required	string
namespace required	string
description	string
allowPersonalCredentials	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",
"namespace": "string",
"description": "string",
"allowPersonalCredentials": true
}

Response samples

201

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"description": "string",
"allowPersonalCredentials": true
}

nameAvailability

Authorizations:

bearerAuth

query Parameters

name required	string
namespace required	string

Responses

Response samples

200

Content type

application/json

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

getAuthDomain

Authorizations:

bearerAuth

path Parameters

id

required

string

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",
"namespace": "string",
"description": "string",
"allowPersonalCredentials": true
}

deleteAuthDomain

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

putAuthDomain

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

_id	string
_created	string <date-time>
_modified	string <date-time>
name required	string
namespace required	string
description	string
allowPersonalCredentials	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",
"namespace": "string",
"description": "string",
"allowPersonalCredentials": true
}

Response samples

200
404

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"description": "string",
"allowPersonalCredentials": true
}

patchAuthDomain

Authorizations:

bearerAuth

path Parameters

id

required

string

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

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"description": "string",
"allowPersonalCredentials": true
}

queryCredentials

Authorizations:

bearerAuth

query Parameters

filter[namespace][EQ]	string
filter[namespace][IN]	Array of strings
filter[authDomain][EQ] required	string
filter[principal][EQ]	string
filter[principal][IN]	Array of strings
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: "_created" "-_created" "_modified" "-_modified" "rank" "-rank" "authDomainId" "-authDomainId" "principal" "-principal"

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",
"authDomainId": "string",
"principal": "string",
"disabled": true,
"label": "string",
"type": "Internal",
"rank": 0
}
],
"authDomains": {"property1": "string",
"property2": "string"
}
}

createCredential

Authorizations:

bearerAuth

Request Body schema: application/json

_id	string
_created	string <date-time>
_modified	string <date-time>
authDomainId required	string
principal required	string
disabled	boolean
label required	string
type required	string (credentialType) Enum: "Internal" "Vault"
	object (rankDefinition)
vaultPath	string
	object

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"authDomainId": "string",
"principal": "string",
"disabled": true,
"label": "string",
"type": "Internal",
"rank": {"position": "Above",
"above": "string",
"below": "string",
"value": 0
},
"vaultPath": "string",
"data": {"property1": "string",
"property2": "string"
}
}

Response samples

202

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"authDomainId": "string",
"principal": "string",
"disabled": true,
"label": "string",
"type": "Internal",
"rank": {"position": "Above",
"above": "string",
"below": "string",
"value": 0
},
"vaultPath": "string",
"data": {"property1": "string",
"property2": "string"
}
}

getCredential

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

200
404

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"authDomainId": "string",
"principal": "string",
"disabled": true,
"label": "string",
"type": "Internal",
"rank": {"position": "Above",
"above": "string",
"below": "string",
"value": 0
},
"vaultPath": "string",
"data": {"property1": "string",
"property2": "string"
}
}

putCredential

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

_id	string
_created	string <date-time>
_modified	string <date-time>
authDomainId required	string
principal required	string
disabled	boolean
label required	string
type required	string (credentialType) Enum: "Internal" "Vault"
	object (rankDefinition)
vaultPath	string
	object

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"authDomainId": "string",
"principal": "string",
"disabled": true,
"label": "string",
"type": "Internal",
"rank": {"position": "Above",
"above": "string",
"below": "string",
"value": 0
},
"vaultPath": "string",
"data": {"property1": "string",
"property2": "string"
}
}

Response samples

200
404

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"authDomainId": "string",
"principal": "string",
"disabled": true,
"label": "string",
"type": "Internal",
"rank": {"position": "Above",
"above": "string",
"below": "string",
"value": 0
},
"vaultPath": "string",
"data": {"property1": "string",
"property2": "string"
}
}

patchCredential

Authorizations:

bearerAuth

path Parameters

id

required

string

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

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"authDomainId": "string",
"principal": "string",
"disabled": true,
"label": "string",
"type": "Internal",
"rank": {"position": "Above",
"above": "string",
"below": "string",
"value": 0
},
"vaultPath": "string",
"data": {"property1": "string",
"property2": "string"
}
}

deleteCredential

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

setCredentialRank

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

position	string (rankPositionEnum) Enum: "Above" "Below" "Between" "Mid" "High" "Low"
above	string
below	string
value	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"position": "Above",
"above": "string",
"below": "string",
"value": 0
}

Response samples

404

Content type

application/json

{"msg": "string"
}

queryMyCredentials

Authorizations:

bearerAuth

query Parameters

filter[namespace][EQ]	string
filter[namespace][IN]	Array of strings
filter[authDomain][EQ]	string
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: "_created" "-_created" "_modified" "-_modified" "rank" "-rank" "authDomainId" "-authDomainId"

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",
"authDomainId": "string",
"principal": "string",
"disabled": true,
"label": "string",
"type": "Internal",
"rank": 0
}
],
"authDomains": {"property1": "string",
"property2": "string"
}
}