samlAttributeMappings
Creates SAML attribute mappings for auto-provisioning.
Content type: Application/json
Supported method: GET, POST, and PUT
Sample URL: http://yourfqdn/admin/service/samlAttributeMappings
GET
Sample request
http://example.com/admin/service/samlAttributeMappings
Sample response
{
"status":{
"code":"200",
"message":"OK"
},
"data":{
"idpmappinglist":[
{
"mappingID":18,
"tenantID":1,
"vidyoAttributeName":"UserName",
"idpAttributeName":"test",
"defaultAttributeValue":""
},
{
"mappingID":19,
"tenantID":1,
"vidyoAttributeName":"UserType",
"idpAttributeName":"",
"defaultAttributeValue":"Normal"
},
{
"mappingID":20,
"tenantID":1,
"vidyoAttributeName":"DisplayName",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":21,
"tenantID":1,
"vidyoAttributeName":"EmailAddress",
"idpAttributeName":"",
"defaultAttributeValue":"yourcompany.com"
},
{
"mappingID":22,
"tenantID":1,
"vidyoAttributeName":"Extension",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":23,
"tenantID":1,
"vidyoAttributeName":"Group",
"idpAttributeName":"",
"defaultAttributeValue":"Default"
},
{
"mappingID":24,
"tenantID":1,
"vidyoAttributeName":"Description",
"idpAttributeName":"",
"defaultAttributeValue":"Idp Provisioned User"
},
{
"mappingID":25,
"tenantID":1,
"vidyoAttributeName":"Proxy",
"idpAttributeName":"",
"defaultAttributeValue":"No Proxy"
},
{
"mappingID":26,
"tenantID":1,
"vidyoAttributeName":"LocationTag",
"idpAttributeName":"",
"defaultAttributeValue":"Default"
},
{
"mappingID":27,
"tenantID":1,
"vidyoAttributeName":"PhoneNumber1",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":28,
"tenantID":1,
"vidyoAttributeName":"PhoneNumber2",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":29,
"tenantID":1,
"vidyoAttributeName":"PhoneNumber3",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":31,
"tenantID":1,
"vidyoAttributeName":"Department",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":32,
"tenantID":1,
"vidyoAttributeName":"Title",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":33,
"tenantID":1,
"vidyoAttributeName":"IM",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":34,
"tenantID":1,
"vidyoAttributeName":"Location",
"idpAttributeName":"",
"defaultAttributeValue":""
}
]
}
}
POST
Sample request
{
"idpmappinglist":[
{
"mappingID":18,
"tenantID":1,
"vidyoAttributeName":"UserName",
"idpAttributeName":"test",
"defaultAttributeValue":""
},
{
"mappingID":19,
"tenantID":1,
"vidyoAttributeName":"UserType",
"idpAttributeName":"",
"defaultAttributeValue":"Normal"
}
]
}
Sample response
{
"status":{
"code":"200",
"message":"OK"
},
"data":{
"idpmappinglist":[
{
"mappingID":18,
"tenantID":1,
"vidyoAttributeName":"UserName",
"idpAttributeName":"test",
"defaultAttributeValue":""
},
{
"mappingID":19,
"tenantID":1,
"vidyoAttributeName":"UserType",
"idpAttributeName":"",
"defaultAttributeValue":"Normal"
}
]
}
}
PUT
Sample request
{
"idpmappinglist":[
{
"mappingID":18,
"tenantID":1,
"vidyoAttributeName":"UserName",
"idpAttributeName":"test",
"defaultAttributeValue":""
},
{
"mappingID":19,
"tenantID":1,
"vidyoAttributeName":"UserType",
"idpAttributeName":"",
"defaultAttributeValue":"Normal"
}
]
}
Sample response
{
"status":{
"code":"200",
"message":"OK"
},
"data":{
"idpmappinglist":[
{
"mappingID":18,
"tenantID":1,
"vidyoAttributeName":"UserName",
"idpAttributeName":"test",
"defaultAttributeValue":""
},
{
"mappingID":19,
"tenantID":1,
"vidyoAttributeName":"UserType",
"idpAttributeName":"",
"defaultAttributeValue":"Normal"
}
]
}
}
Request parameter
|
Name |
Type |
Description |
Required |
|---|---|---|---|
|
MappingID |
String |
ID |
Yes |
|
vidyoAttributeName |
String |
The attribute name that Vidyo uses |
Yes |
|
idpAttributeName |
String |
The IDP/IDAP attribute that will be mapped to the name of the Vidyo attribute |
Yes |
|
defaultAttributeValue |
Boolean |
Default value if nothing is mapped |
No |
|
tenantID |
Integer |
Tenant ID |
Yes |