aam authentication relay ws-federation¶

WS-Federation Authentication Relay

ws-federation Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name ws-federation-list

Collection URI /axapi/v3/aam/authentication/relay/ws-federation

Element Name ws-federation

Element URI /axapi/v3/aam/authentication/relay/ws-federation/{name}

Element Attributes ws-federation_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/aam/authentication/relay/ws-federation/{name}/stats

Schema ws-federation schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/aam/authentication/relay/ws-federation	ws-federation attributes
POST /axapi/v3/aam/authentication/relay/ws-federation/ Payload: { "ws-federation": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/aam/authentication/relay/ws-federation	ws-federation attributes
Get Object	GET	/axapi/v3/aam/authentication/relay/ws-federation/{name}	ws-federation attributes
GET /axapi/v3/aam/authentication/relay/ws-federation/a Reponse: { "ws-federation": { "name": "a", "uuid": "9e3b930a-4f58-11ee-bde4-3768133b9b1a", "user-tag": "a", "a10-url": "/axapi/v3/aam/authentication/relay/ws-federation/a" } }
Get List	GET	/axapi/v3/aam/authentication/relay/ws-federation	ws-federation-list
Modify Object	POST	/axapi/v3/aam/authentication/relay/ws-federation/{name}	ws-federation attributes
Replace Object	PUT	/axapi/v3/aam/authentication/relay/ws-federation/{name}	ws-federation attributes
PUT /axapi/v3/aam/authentication/relay/ws-federation/a Payload: { "ws-federation": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/aam/authentication/relay/ws-federation	ws-federation-list
Delete Object	DELETE	/axapi/v3/aam/authentication/relay/ws-federation/{name}	ws-federation attributes
DELETE /axapi/v3/aam/authentication/relay/ws-federation/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

ws-federation-list¶

ws-federation-list is JSON List of ws-federation attributes

ws-federation-list : [

{ ws-federation attributes },

{ ws-federation attributes },

…

]

ws-federation attributes¶

application-server

Description ‘sharepoint’: Microsoft SharePoint; ‘exchange-owa’: Microsoft Exchange OWA;

Type: string

Supported Values: sharepoint, exchange-owa

authentication-uri

Description Specify WS-Federation relay URI, default is /_trust/

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

name

Description Specify WS-Federation authentication relay name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

packet-capture-template

Description Name of the packet capture template to be bind with this object

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/visibility/packet-capture/object-templates/aam-auth-relay-ws-fed-tmpl

sampling-enable

Type: List

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘request’: Request; ‘success’: Success; ‘failure’: Failure;

Type: string

Supported Values: all, request, success, failure