Lan Secrets
Lan Secrets
The lan secret API allows users to manage secrets needed to access stream access points.
Lan Secrets Overview
| Method | API Path | Description |
|---|---|---|
|
Create a lan secret |
|
|
Delete a lan secret |
Details
Create a lan secret
POST /api/lan_secrets
Create a lan secret on a stream gateway.
The caller is authorized based on the stream gateway identity policies, so users with no assigned roles on the endpoint may be permitted to access this operation.
Request body
Request to create a LAN secret
Name |
Type |
Description |
DATA_TYPE |
string |
Type of this document |
expires_in_mins |
integer |
Expiration time for this lan secret |
identity_id |
string <uuid> |
Optional requested identity_id to be used with the lan_secret. If present, the caller must have the identity in the active identity set and have a valid mapping for that identity in the stream gateway policy. If not present the first identity in the caller’s identity set which meets the stream gateway’s access policy will be used. |
stream_access_point_id |
string <uuid> |
ID of the stream access point that this secret can be used with. |
tunnel_id |
string <uuid> |
ID of the tunnel that this secret can be used with. |
username |
string |
Optional requested username to be used with the lan_secret. If present, the caller’s identity (perhaps constrained by the identity_id property of the create document) must be mappable to this username by the stream gateway’s identity policy. |
Example
{
"DATA_TYPE": "lan_secret_create#1.0.0",
"expires_in_mins": 0,
"identity_id": "011a42b9-62d7-49eb-8328-c2e454af88a1",
"stream_access_point_id": "d7d6c4f7-b541-46f4-ac63-8485a05f42c6",
"tunnel_id": "02c85b8b-41a6-4131-a170-70d62bfc42a8",
"username": "string"
}Responses
201 - Create lan secret response
This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.
Version 1.1.0 adds optional authorization_parameters to help process authorization or authentication errors
One of the following schemas:
{
"code": "string",
"data": [
{
"DATA_TYPE": "lan_secret#1.0.0",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identity_id": "string",
"secret": "string",
"stream_access_point_id": "d7d6c4f7-b541-46f4-ac63-8485a05f42c6",
"expires": 0,
"tunnel_id": "02c85b8b-41a6-4131-a170-70d62bfc42a8",
"username": "string"
}
],
"DATA_TYPE": "result#1.0.0",
"detail": null,
"has_next_page": false,
"http_response_code": 100,
"marker": "string",
"message": "string"
}Details
Delete a lan secret
DELETE /api/lan_secrets/{lan_secret_id}
Delete a lan secret.
The caller must have the identity_id of the lan secret in its identity set.
Responses
200 - Delete lan secret response
This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.
Version 1.1.0 adds optional authorization_parameters to help process authorization or authentication errors
One of the following schemas:
{
"DATA_TYPE": "result#1.0.0",
"code": "string",
"data": [
{}
],
"detail": null,
"has_next_page": false,
"http_response_code": 100,
"marker": "string",
"message": "string"
}403 - Permission denied
This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.
Version 1.1.0 adds optional authorization_parameters to help process authorization or authentication errors
One of the following schemas:
{
"code": "string",
"http_response_code": 100,
"detail": null,
"DATA_TYPE": "result#1.0.0",
"data": [
{}
],
"has_next_page": false,
"marker": "string",
"message": "string"
}