This article contains a list of REST API commands that pertain to channel authentications.
For a walk-through of the Navigator REST API using the demo site, see Using the REST API using the Navigator demo system. No installation is required. The article Performing REST API operations using the Swagger UI includes three detailed examples, as well as instructions for issuing plain text or JSON-formatted MQSC Commands through the REST API.
|
Jump ahead: |
Search Channel Authentications
GET /ibmmq/channel-auths
Purpose: Lists the requested attributes of the channel authentications that meet the specified criteria.
Curl example
curl -X GET "http://jenkins.nastel.com:8019/rest/v1/ibmmq/channel-auths?nodeName=LEUNAME&type=Block%20User%20Map&attributes=%2A" -H "accept: application/json" -H "Authorization: Basic QWRtaW46YWRtaW4="
Example Response
[
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "EMIK",
"name": "*",
"type": "Block User Map",
"uri": "/rest/v1/ibmmq/channel-auths/LEUNAME/EMIK/*/Block%20User%20Map",
"general": {
"description": "Default rule to disallow privileged users",
"userList": [
"*MQADMIN"
],
"addrList": [],
"sslPeer": "",
"sslCertIssuer": "",
"address": "",
"clntUserID": "",
"remoteQMgrName": ""
},
"extended": {
"userSrc": "Map",
"mcaUser": "",
"warn": "No",
"checkClient": "Optional",
"custom": ""
},
"state": {
"lastUpdated": 1643923713000,
"alterDate": "2021-08-06",
"alterTime": "13.28.43"
},
"jobs": {
"totalJobCount": 0,
"scheduledJobCount": 0,
"canceledJobCount": 0,
"successJobCount": 0,
"failedJobCount": 0,
"readyJobCount": 0,
"pendingJobCount": 0,
"jobIds": []
},
"customProperties": {}
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "QA",
"name": "BANK.DEF.SVRCONN",
"type": "Block User Map",
"uri": "/rest/v1/ibmmq/channel-auths/LEUNAME/QA/BANK.DEF.SVRCONN/Block%20User%20Map",
"general": {
"description": "Test Multiple Properties",
"userList": [
"MQADMIN"
],
"addrList": [],
"sslPeer": "",
"sslCertIssuer": "",
"address": "",
"clntUserID": "",
"remoteQMgrName": ""
},
"extended": {
"userSrc": "Map",
"mcaUser": "",
"warn": "No",
"checkClient": "Optional",
"custom": ""
},
"state": {
"lastUpdated": 1643924163000,
"alterDate": "2021-12-29",
"alterTime": "06.38.46"
},
"jobs": {
"totalJobCount": 0,
"scheduledJobCount": 0,
"canceledJobCount": 0,
"successJobCount": 0,
"failedJobCount": 0,
"readyJobCount": 0,
"pendingJobCount": 0,
"jobIds": []
},
"customProperties": {}
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "QA",
"name": "New.Channel.Icon",
"type": "Block User Map",
"uri": "/rest/v1/ibmmq/channel-auths/LEUNAME/QA/New.Channel.Icon/Block%20User%20Map",
"general": {
"description": "Test Multiple Properties",
"userList": [
"MQADMIN"
],
"addrList": [],
"sslPeer": "",
"sslCertIssuer": "",
"address": "",
"clntUserID": "",
"remoteQMgrName": ""
},
"extended": {
"userSrc": "Map",
"mcaUser": "",
"warn": "No",
"checkClient": "Optional",
"custom": ""
},
"state": {
"lastUpdated": 1643924163000,
"alterDate": "2021-08-17",
"alterTime": "06.15.11"
},
"jobs": {
"totalJobCount": 0,
"scheduledJobCount": 0,
"canceledJobCount": 0,
"successJobCount": 0,
"failedJobCount": 0,
"readyJobCount": 0,
"pendingJobCount": 0,
"jobIds": []
},
"customProperties": {}
}
]
Read Channel Authentication Data
GET /ibmmq/channel-auths/{nodeName}/{qmgrName}/{channelAuthName}/{type}
Purpose: Provides data for the specified channel authentication name and type on the specified node and queue manager.
Curl example
curl -X GET "http://jenkins.nastel.com:8019/rest/v1/ibmmq/channel-auths/LEUNAME/QA/New.Channel.Icon/Block%20User%20Map?attributes=%2A" -H "accept: application/json" -H "Authorization: Basic QWRtaW46YWRtaW4="
Example Response
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "QA",
"name": "New.Channel.Icon",
"type": "Block User Map",
"uri": "/rest/v1/ibmmq/channel-auths/LEUNAME/QA/New.Channel.Icon/Block%20User%20Map",
"general": {
"description": "Test Multiple Properties",
"userList": [
"MQADMIN"
],
"addrList": [],
"sslPeer": "",
"sslCertIssuer": "",
"address": "",
"clntUserID": "",
"remoteQMgrName": ""
},
"extended": {
"userSrc": "Map",
"mcaUser": "",
"warn": "No",
"checkClient": "Optional",
"custom": ""
},
"state": {
"lastUpdated": 1643924763000,
"alterDate": "2021-08-17",
"alterTime": "06.15.11"
},
"jobs": {
"totalJobCount": 0,
"scheduledJobCount": 0,
"canceledJobCount": 0,
"successJobCount": 0,
"failedJobCount": 0,
"readyJobCount": 0,
"pendingJobCount": 0,
"jobIds": []
},
"customProperties": {}
}