External Authorization Services API documentation version v1

http://example.com/ExternalAuthServices/

/extAuthRest

post

post

Manages the request related to a list of permissions or roles that can be added, removed or renewed according to the request type

Manages the request related to a list of permissions or roles that can be added, removed or renewed according to the request type

URI Parameters

  • realm: required (string)

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object",
  "required": true,
  "properties": {
    "request": {
      "type": "object",
      "properties": {
        "parentId": {
          "type": "number"
        },
        "requestId": {
          "type": "number"
        },
        "requestType": {
          "enum": [
            "ROLE_ASSIGN",
            "ROLE_REMOVAL",
            "ROLE_RENEWAL"
          ]
        },
         "requestStatus": {
          "enum": [
            "AUTHORIZABLE"
          ]
        },
        "createdOn": {
          "type": "string"
        },
        "note": {
          "type": "string"
        },
        "authorizationToken": {
          "type": "string"
        }
      }
    },
    "applicant": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "surname": {
          "type": "string"
        },
        "userid": {
          "type": "string"
        }
      }
    },
    "beneficiary": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "surname": {
          "type": "string"
        },
        "userid": {
          "type": "string"
        },
        "roles": {
          "type": "array",
          "items": [
            {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "application_name": {
                  "type": "string"
                },
                "type": {
                  "type": "number"
                },
                "functionality_type": {
                  "type": "string"
                }
              }
            }
          ]
        }
      }
    }
  }
}

Example:

{
    "request": {
      "parentId": "123",
      "requestId": "123",
      "requestType": "ROLE_ASSIGN",
      "requestStatus": "AUTHORIZABLE",
      "createdOn": "1442314092793",
      "note": "str1234",
      "authorizationToken": "str1234"
    },
    "roles": [
      {
        "name": "str1234",
        "application_name": "str1234",
        "type": "123",
        "functionality_type": "str1234"
      },
      {
        "name": "str1234",
        "application_name": "str1234",
        "type": "123",
        "functionality_type": "str1234"
      }
    ],
    "applicant": {
      "name": "str1234",
      "surname": "str1234",
      "userid": "str1234"
    },
    "beneficiary": {
      "name": "str1234",
      "surname": "str1234",
      "userid": "str1234"
    }
}

HTTP status code 200

A numeric value that represents the request status:
1 = AUTHORIZED
2 = REJECTED
3 = WAITING_ASYNCHRONOUS
4 = WAITING_SYNCHRONOUS

Body

Type: text/plain

HTTP status code 500

Internal server error

post

post

Manages the request related to a list of permissions or roles that can be added, removed or renewed according to the request type

Manages the request related to a list of permissions or roles that can be added, removed or renewed according to the request type

URI Parameters

  • realm: required (string)

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object",
  "required": true,
  "properties": {
    "request": {
      "type": "object",
      "properties": {
        "parentId": {
          "type": "number"
        },
        "requestId": {
          "type": "number"
        },
        "requestType": {
          "enum": [
            "USER_ACCESS_CHANGE"
          ]
        },
        "requestStatus": {
          "enum": [
             "AUTHORIZABLE"
          ]
        },
        "createdOn": {
          "type": "string"
        },
        "note": {
          "type": "string"
        },
        "authorizationToken": {
          "type": "string"
        }
      }
    },
    "applicant": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "surname": {
          "type": "string"
        },
        "userid": {
          "type": "string"
        }
      }
    },
    "beneficiary": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "surname": {
          "type": "string"
        },
        "userid": {
          "type": "string"
        }
      }
    },
    "roles": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "application_name": {
              "type": "string"
            },
            "type": {
              "type": "number"
            },
            "functionality_type": {
              "type": "string"
            }
          }
        }
      ]
    },
    "rolesToRemove": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "application_name": {
              "type": "string"
            },
            "type": {
              "type": "number"
            },
            "functionality_type": {
              "type": "string"
            }
          }
        }
      ]
    },
    "rolesToRenew": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "application_name": {
              "type": "string"
            },
            "type": {
              "type": "number"
            },
            "functionality_type": {
              "type": "string"
            }
          }
        }
      ]
    }
  }
}

Example:

{
  "request": {
    "parentId": "123",
    "requestId": "123",
    "requestType": "USER_ACCESS_CHANGE",
    "requestStatus": "AUTHORIZABLE",
    "createdOn": "1442314092793",
    "note": "str1234",
    "authorizationToken": "str1234"
  },
  "applicant": {
    "name": "str1234",
    "surname": "str1234",
    "userid": "str1234"
  },
  "beneficiary": {
    "name": "str1234",
    "surname": "str1234",
    "userid": "str1234"
  },
  "rolesToRemove": [
    {
      "name": "str1234",
      "application_name": "str1234",
      "type": "123",
      "functionality_type": "str1234"
    },
    {
      "name": "str1234",
      "application_name": "str1234",
      "type": "123",
      "functionality_type": "str1234"
    }
  ],
  "rolesToRenew": [
    {
      "name": "str1234",
      "application_name": "str1234",
      "type": "123",
      "functionality_type": "str1234"
    },
    {
      "name": "str1234",
      "application_name": "str1234",
      "type": "123",
      "functionality_type": "str1234"
    }
  ],
  "roles": [
    {
      "name": "str1234",
      "application_name": "str1234",
      "type": "123",
      "functionality_type": "str1234"
    },
    {
      "name": "str1234",
      "application_name": "str1234",
      "type": "123",
      "functionality_type": "str1234"
    }
  ]
}

HTTP status code 200

A numeric value that represents the request status:
1 = AUTHORIZED
2 = REJECTED
3 = WAITING_ASYNCHRONOUS
4 = WAITING_SYNCHRONOUS

Body

Type: text/plain

HTTP status code 500

Internal server error