CR APIs

API Collection:

PreviousIAM APIs NextIntegration with Router

Last updated 10 days ago

Was this helpful?

Get Entities by Type

To fetch the metadata of all the entities of a specific type (FIU or FIP or AA).

get

/v2/entityInfo/{type}

Authorizations

Path parameters

typestring · enumrequired

Type of entity

Options: FIU, FIP, AA

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.sandbox.sahamati.org.in/cr/v2/entityInfo/{type}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

{
  "ver": "1.0",
  "timestamp": "2024-10-16 08:04:50.314",
  "txnid": "1fbb-11ed-861d-0242",
  "requester": {
    "name": "text",
    "id": "text"
  },
  "entityinfo": {
    "name": "text",
    "id": "text",
    "code": "text",
    "entityhandle": "text",
    "baseurl": "text",
    "webviewurl": "text",
    "fitypes": [
      "text"
    ],
    "inboundports": [
      "text"
    ],
    "outboundports": [
      "text"
    ],
    "ips": [
      "text"
    ],
    "certificate": {
      "alg": "text",
      "e": "text",
      "kid": "text",
      "kty": "text",
      "n": "text",
      "use": "text"
    },
    "tokeninfo": {
      "url": "text",
      "desc": "text"
    },
    "Identifiers": [
      {
        "category": "text",
        "type": "text"
      }
    ]
  }
}

Successful retrieval

Get Entity by Type and ID

To fetch the metadata of a specific entity by its type and ID

get

/v2/entityInfo/{type}//{id}