Authorizer

principals

Download Spec

get/authorizer/api/v1/principals

Get defined principals from the authorizer

Authorizationstring

required

OAuth2 token

Default: "Bearer a-proper-token-goes-here"

Responses

Response examples

Successful response, returns an array of principal objects

[
  {
    "size": 4096,
    "id": "35d175f2-6ecd-4872-1432-9be19d203ae0",
    "group_id": "14d185f2-6ecd-4872-1432-9be19d203ae0",
    "comment": "Principal user 'admins'",
    "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAACAQCis7ZhbaXnTqCT9+DaStgcV1flVoxp1FYfSB13FU4FAaZHEw6rKe+mVskNGNJkhvQrGNo0lDTl5o/ZL3uRYDUUQcx8dcALtmfcFnlHyhmfBqF2/i4zThBfoHO+YlaPGDTzww6L03Og0P2RZu6xPGOZ+nDCbGyxeWpDE8SzPMjqNEbFVyr1s1ZvzZ4PknHgATkdfTUtDDHTQ775R5A/2WBEbpa0IclQGxiUXGTS+m7DZ6rGkUuedIeaPV/AHQ3QG97lyz7WRV1PUUPkmG0EEMrjgV8/Ig1bJJH1Ac0JrR58UFfpWMGYoT6Aq8eD+wZSv9dg8GzUE11muqhGVukRw72nWNKg3GN7RsHLJfrShYDhFgKR1Bw8qYj3A/nS+9oqKb5M8FfVwjxhm1jlK1IxwgFkzoDU4rQRuh9I5ZI0aXy1axR7V1/G06/lyVxIXw0OERiDQvxWt/aZGR/kaTxyyGOtpOhd9PG5+rjZ9B86G6YyxPmvDsuTJNkcboocrEVcEFYrffWw6qfb7XoMO8z4LHw2y5Kyh4+LuOvtZN7oIZEUYthQYM0yE1yis5BpfH8N7vw221llX1F9VApEH1hxL31lmA7gU42r3zvRB1JWw53xUdCCKl0+wWogpgO1t393hCSJI5/hSQHbXXeClUFlzfE5Ozw7aLK6hV7MvPDc8dcztw==",
    "type": "ssh-rsa",
    "public_key_string": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCis7ZhbaXnTqCT9+DaStgcV1flVoxp1FYfSB13FU4FAaZHEw6rKe+mVskNGNJkhvQrGNo0lDTl5o/ZL3uRYDUUQcx8dcALtmfcFnlHyhmfBqF2/i4zThBfoHO+YlaPGDTzww6L03Og0P2RZu6xPGOZ+nDCbGyxeWpDE8SzPMjqNEbFVyr1s1ZvzZ4PknHgATkdfTUtDDHTQ775R5A/2WBEbpa0IclQGxiUXGTS+m7DZ6rGkUuedIeaPV/AHQ3QG97lyz7WRV1PUUPkmG0EEMrjgV8/Ig1bJJH1Ac0JrR58UFfpWMGYoT6Aq8eD+wZSv9dg8GzUE11muqhGVukRw72nWNKg3GN7RsHLJfrShYDhFgKR1Bw8qYj3A/nS+9oqKb5M8FfVwjxhm1jlK1IxwgFkzoDU4rQRuh9I5ZI0aXy1axR7V1/G06/lyVxIXw0OERiDQvxWt/aZGR/kaTxyyGOtpOhd9PG5+rjZ9B86G6YyxPmvDsuTJNkcboocrEVcEFYrffWw6qfb7XoMO8z4LHw2y5Kyh4+LuOvtZN7oIZEUYthQYM0yE1yis5BpfH8N7vw221llX1F9VApEH1hxL31lmA7gU42r3zvRB1JWw53xUdCCKl0+wWogpgO1t393hCSJI5/hSQHbXXeClUFlzfE5Ozw7aLK6hV7MvPDc8dcztw== Ordain principal 'oracle-admins'"
  }
]

get/authorizer/api/v1/principals/{group_id}

Gets the principal key by its group ID.

key_idstring

optional parameter to request specific principal key

filterstring

if filter=all then all principal keys are returned

Responses

Response examples

Successful response, returns a principal object

{
  "size": 4096,
  "id": "35d175f2-6ecd-4872-1432-9be19d203ae0",
  "group_id": "14d185f2-6ecd-4872-1432-9be19d203ae0",
  "comment": "Principal user 'admins'",
  "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAACAQCis7ZhbaXnTqCT9+DaStgcV1flVoxp1FYfSB13FU4FAaZHEw6rKe+mVskNGNJkhvQrGNo0lDTl5o/ZL3uRYDUUQcx8dcALtmfcFnlHyhmfBqF2/i4zThBfoHO+YlaPGDTzww6L03Og0P2RZu6xPGOZ+nDCbGyxeWpDE8SzPMjqNEbFVyr1s1ZvzZ4PknHgATkdfTUtDDHTQ775R5A/2WBEbpa0IclQGxiUXGTS+m7DZ6rGkUuedIeaPV/AHQ3QG97lyz7WRV1PUUPkmG0EEMrjgV8/Ig1bJJH1Ac0JrR58UFfpWMGYoT6Aq8eD+wZSv9dg8GzUE11muqhGVukRw72nWNKg3GN7RsHLJfrShYDhFgKR1Bw8qYj3A/nS+9oqKb5M8FfVwjxhm1jlK1IxwgFkzoDU4rQRuh9I5ZI0aXy1axR7V1/G06/lyVxIXw0OERiDQvxWt/aZGR/kaTxyyGOtpOhd9PG5+rjZ9B86G6YyxPmvDsuTJNkcboocrEVcEFYrffWw6qfb7XoMO8z4LHw2y5Kyh4+LuOvtZN7oIZEUYthQYM0yE1yis5BpfH8N7vw221llX1F9VApEH1hxL31lmA7gU42r3zvRB1JWw53xUdCCKl0+wWogpgO1t393hCSJI5/hSQHbXXeClUFlzfE5Ozw7aLK6hV7MvPDc8dcztw==",
  "type": "ssh-rsa",
  "public_key_string": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCis7ZhbaXnTqCT9+DaStgcV1flVoxp1FYfSB13FU4FAaZHEw6rKe+mVskNGNJkhvQrGNo0lDTl5o/ZL3uRYDUUQcx8dcALtmfcFnlHyhmfBqF2/i4zThBfoHO+YlaPGDTzww6L03Og0P2RZu6xPGOZ+nDCbGyxeWpDE8SzPMjqNEbFVyr1s1ZvzZ4PknHgATkdfTUtDDHTQ775R5A/2WBEbpa0IclQGxiUXGTS+m7DZ6rGkUuedIeaPV/AHQ3QG97lyz7WRV1PUUPkmG0EEMrjgV8/Ig1bJJH1Ac0JrR58UFfpWMGYoT6Aq8eD+wZSv9dg8GzUE11muqhGVukRw72nWNKg3GN7RsHLJfrShYDhFgKR1Bw8qYj3A/nS+9oqKb5M8FfVwjxhm1jlK1IxwgFkzoDU4rQRuh9I5ZI0aXy1axR7V1/G06/lyVxIXw0OERiDQvxWt/aZGR/kaTxyyGOtpOhd9PG5+rjZ9B86G6YyxPmvDsuTJNkcboocrEVcEFYrffWw6qfb7XoMO8z4LHw2y5Kyh4+LuOvtZN7oIZEUYthQYM0yE1yis5BpfH8N7vw221llX1F9VApEH1hxL31lmA7gU42r3zvRB1JWw53xUdCCKl0+wWogpgO1t393hCSJI5/hSQHbXXeClUFlzfE5Ozw7aLK6hV7MvPDc8dcztw== Ordain principal 'oracle-admins'"
}

delete/authorizer/api/v1/principals/{group_id}

Deletes the principal key by its group ID.

key_idstring

optional parameter to delete specific principal key

Responses

Response examples

Successful response

Empty response

post/authorizer/api/v1/principals/{group_id}/create

Create a principal key pair.

group_idstring

required

Principal group ID

Responses

Response examples

Successful response, returns a signature

{
  "size": 4096,
  "id": "35d175f2-6ecd-4872-1432-9be19d203ae0",
  "group_id": "14d185f2-6ecd-4872-1432-9be19d203ae0",
  "comment": "Principal user 'admins'",
  "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAACAQCis7ZhbaXnTqCT9+DaStgcV1flVoxp1FYfSB13FU4FAaZHEw6rKe+mVskNGNJkhvQrGNo0lDTl5o/ZL3uRYDUUQcx8dcALtmfcFnlHyhmfBqF2/i4zThBfoHO+YlaPGDTzww6L03Og0P2RZu6xPGOZ+nDCbGyxeWpDE8SzPMjqNEbFVyr1s1ZvzZ4PknHgATkdfTUtDDHTQ775R5A/2WBEbpa0IclQGxiUXGTS+m7DZ6rGkUuedIeaPV/AHQ3QG97lyz7WRV1PUUPkmG0EEMrjgV8/Ig1bJJH1Ac0JrR58UFfpWMGYoT6Aq8eD+wZSv9dg8GzUE11muqhGVukRw72nWNKg3GN7RsHLJfrShYDhFgKR1Bw8qYj3A/nS+9oqKb5M8FfVwjxhm1jlK1IxwgFkzoDU4rQRuh9I5ZI0aXy1axR7V1/G06/lyVxIXw0OERiDQvxWt/aZGR/kaTxyyGOtpOhd9PG5+rjZ9B86G6YyxPmvDsuTJNkcboocrEVcEFYrffWw6qfb7XoMO8z4LHw2y5Kyh4+LuOvtZN7oIZEUYthQYM0yE1yis5BpfH8N7vw221llX1F9VApEH1hxL31lmA7gU42r3zvRB1JWw53xUdCCKl0+wWogpgO1t393hCSJI5/hSQHbXXeClUFlzfE5Ozw7aLK6hV7MvPDc8dcztw==",
  "type": "ssh-rsa",
  "public_key_string": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCis7ZhbaXnTqCT9+DaStgcV1flVoxp1FYfSB13FU4FAaZHEw6rKe+mVskNGNJkhvQrGNo0lDTl5o/ZL3uRYDUUQcx8dcALtmfcFnlHyhmfBqF2/i4zThBfoHO+YlaPGDTzww6L03Og0P2RZu6xPGOZ+nDCbGyxeWpDE8SzPMjqNEbFVyr1s1ZvzZ4PknHgATkdfTUtDDHTQ775R5A/2WBEbpa0IclQGxiUXGTS+m7DZ6rGkUuedIeaPV/AHQ3QG97lyz7WRV1PUUPkmG0EEMrjgV8/Ig1bJJH1Ac0JrR58UFfpWMGYoT6Aq8eD+wZSv9dg8GzUE11muqhGVukRw72nWNKg3GN7RsHLJfrShYDhFgKR1Bw8qYj3A/nS+9oqKb5M8FfVwjxhm1jlK1IxwgFkzoDU4rQRuh9I5ZI0aXy1axR7V1/G06/lyVxIXw0OERiDQvxWt/aZGR/kaTxyyGOtpOhd9PG5+rjZ9B86G6YyxPmvDsuTJNkcboocrEVcEFYrffWw6qfb7XoMO8z4LHw2y5Kyh4+LuOvtZN7oIZEUYthQYM0yE1yis5BpfH8N7vw221llX1F9VApEH1hxL31lmA7gU42r3zvRB1JWw53xUdCCKl0+wWogpgO1t393hCSJI5/hSQHbXXeClUFlzfE5Ozw7aLK6hV7MvPDc8dcztw== Ordain principal 'oracle-admins'"
}

post/authorizer/api/v1/principals/{group_id}/import

Import a principal key pair.

algorithmstring

private key algorithm, "RSA", "ECDSA" or "Ed25519"

Example: "RSA"

datastring

base64 encoded private key DER data

Responses

Request examples

{
  "algorithm": "RSA",
  "data": "string"
}

Response examples

Successful response, returns a signature

{
  "size": 4096,
  "id": "35d175f2-6ecd-4872-1432-9be19d203ae0",
  "group_id": "14d185f2-6ecd-4872-1432-9be19d203ae0",
  "comment": "Principal user 'admins'",
  "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAACAQCis7ZhbaXnTqCT9+DaStgcV1flVoxp1FYfSB13FU4FAaZHEw6rKe+mVskNGNJkhvQrGNo0lDTl5o/ZL3uRYDUUQcx8dcALtmfcFnlHyhmfBqF2/i4zThBfoHO+YlaPGDTzww6L03Og0P2RZu6xPGOZ+nDCbGyxeWpDE8SzPMjqNEbFVyr1s1ZvzZ4PknHgATkdfTUtDDHTQ775R5A/2WBEbpa0IclQGxiUXGTS+m7DZ6rGkUuedIeaPV/AHQ3QG97lyz7WRV1PUUPkmG0EEMrjgV8/Ig1bJJH1Ac0JrR58UFfpWMGYoT6Aq8eD+wZSv9dg8GzUE11muqhGVukRw72nWNKg3GN7RsHLJfrShYDhFgKR1Bw8qYj3A/nS+9oqKb5M8FfVwjxhm1jlK1IxwgFkzoDU4rQRuh9I5ZI0aXy1axR7V1/G06/lyVxIXw0OERiDQvxWt/aZGR/kaTxyyGOtpOhd9PG5+rjZ9B86G6YyxPmvDsuTJNkcboocrEVcEFYrffWw6qfb7XoMO8z4LHw2y5Kyh4+LuOvtZN7oIZEUYthQYM0yE1yis5BpfH8N7vw221llX1F9VApEH1hxL31lmA7gU42r3zvRB1JWw53xUdCCKl0+wWogpgO1t393hCSJI5/hSQHbXXeClUFlzfE5Ozw7aLK6hV7MvPDc8dcztw==",
  "type": "ssh-rsa",
  "public_key_string": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCis7ZhbaXnTqCT9+DaStgcV1flVoxp1FYfSB13FU4FAaZHEw6rKe+mVskNGNJkhvQrGNo0lDTl5o/ZL3uRYDUUQcx8dcALtmfcFnlHyhmfBqF2/i4zThBfoHO+YlaPGDTzww6L03Og0P2RZu6xPGOZ+nDCbGyxeWpDE8SzPMjqNEbFVyr1s1ZvzZ4PknHgATkdfTUtDDHTQ775R5A/2WBEbpa0IclQGxiUXGTS+m7DZ6rGkUuedIeaPV/AHQ3QG97lyz7WRV1PUUPkmG0EEMrjgV8/Ig1bJJH1Ac0JrR58UFfpWMGYoT6Aq8eD+wZSv9dg8GzUE11muqhGVukRw72nWNKg3GN7RsHLJfrShYDhFgKR1Bw8qYj3A/nS+9oqKb5M8FfVwjxhm1jlK1IxwgFkzoDU4rQRuh9I5ZI0aXy1axR7V1/G06/lyVxIXw0OERiDQvxWt/aZGR/kaTxyyGOtpOhd9PG5+rjZ9B86G6YyxPmvDsuTJNkcboocrEVcEFYrffWw6qfb7XoMO8z4LHw2y5Kyh4+LuOvtZN7oIZEUYthQYM0yE1yis5BpfH8N7vw221llX1F9VApEH1hxL31lmA7gU42r3zvRB1JWw53xUdCCKl0+wWogpgO1t393hCSJI5/hSQHbXXeClUFlzfE5Ozw7aLK6hV7MvPDc8dcztw== Ordain principal 'oracle-admins'"
}

post/authorizer/api/v1/principals/{group_id}/sign

Get a signature.

typestring

signature type

Enum: ssh-rsa
rsa-sha2-256
rsa-sha2-512
ssh-ed25519
ecdsa-sha2-nistp224
ecdsa-sha2-nistp256
ecdsa-sha2-nistp384
ecdsa-sha2-nistp521
ssh-dss

datastring

Data to be signed base64 encoded without padding characters

Example: "AAAAIONvYWMEdcQRxwQwyIoB9CWmlJur6MoMxAdire3b04SnMgAAAARyb290AAAADnNzaC1jb25uZWN0aW9uAAAACXB1YmxpY2tleQEAAAAMcnNhLXNoYTItNTEyAAACFwAAAAdzc2gtcnNhAAAAAwEAAQAAAgEAoWMY6ZzstIYHiVakTuf2eDN22ds6b7jNWwVDBzy0XD0K2F7MkkpBkwE5cSCGwdoLrrySWRmZMFobbiklrEZCCz5BQXN87dfPHzSjn3xO8oRaxdBLfhon4gKSfk5LNozvn7GV87pI6RXe+S2Wgvp5yiql+DSGgwWiQHaaRxnYcjd801p8hSknwfi6bUPwj+CD91fynF+z3iK6nwuvhFEDtm2H+ickbuEyDlqmUnEMpj7ObY3ivIyqtSRKFSUEdXaSblcZdVwMr2it5MMSa6UiGuWTapCoCeRJSDMCjRQteRm5cZKRO1aJhc6Hj1GTZM9ImZeBsZqnVbK9sjGPIw8q84qEvNxu0Yc4dUgCOjJc9zkwvgGokxw1+lsEyZlsaHHQuXU9aKnetslH1TAcj+ytl4IkhXJmCxD/RRTYU24DK/cVOMpJJNNiD9NtXAFIJI1hXMVdo9ni5eX58qfUbEcbLfoVgXZukpVby98GtiOZvxH7WKEJN2+lVWhMRuemlPXe7ig8hGRon2s9YiwAuMOor9PNNV0Tk4Iymko4f7flHZBlminvA2YdJLrihVRHPX/mwU0pc1Zayfo0ux35qZcTZL4nRqfEivLZY6taLk62+r3Y/Om8eiNDPwsDahr2bxqlz195H1sQxDW6sawTsSb90piE9FVqe6V3cZHHb7GxY7U"

Responses

Request examples

{
  "type": "ssh-rsa",
  "data": "AAAAIONvYWMEdcQRxwQwyIoB9CWmlJur6MoMxAdire3b04SnMgAAAARyb290AAAADnNzaC1jb25uZWN0aW9uAAAACXB1YmxpY2tleQEAAAAMcnNhLXNoYTItNTEyAAACFwAAAAdzc2gtcnNhAAAAAwEAAQAAAgEAoWMY6ZzstIYHiVakTuf2eDN22ds6b7jNWwVDBzy0XD0K2F7MkkpBkwE5cSCGwdoLrrySWRmZMFobbiklrEZCCz5BQXN87dfPHzSjn3xO8oRaxdBLfhon4gKSfk5LNozvn7GV87pI6RXe+S2Wgvp5yiql+DSGgwWiQHaaRxnYcjd801p8hSknwfi6bUPwj+CD91fynF+z3iK6nwuvhFEDtm2H+ickbuEyDlqmUnEMpj7ObY3ivIyqtSRKFSUEdXaSblcZdVwMr2it5MMSa6UiGuWTapCoCeRJSDMCjRQteRm5cZKRO1aJhc6Hj1GTZM9ImZeBsZqnVbK9sjGPIw8q84qEvNxu0Yc4dUgCOjJc9zkwvgGokxw1+lsEyZlsaHHQuXU9aKnetslH1TAcj+ytl4IkhXJmCxD/RRTYU24DK/cVOMpJJNNiD9NtXAFIJI1hXMVdo9ni5eX58qfUbEcbLfoVgXZukpVby98GtiOZvxH7WKEJN2+lVWhMRuemlPXe7ig8hGRon2s9YiwAuMOor9PNNV0Tk4Iymko4f7flHZBlminvA2YdJLrihVRHPX/mwU0pc1Zayfo0ux35qZcTZL4nRqfEivLZY6taLk62+r3Y/Om8eiNDPwsDahr2bxqlz195H1sQxDW6sawTsSb90piE9FVqe6V3cZHHb7GxY7U"
}

Response examples

Successful response, returns a signature

{
  "signature": "AAAAB3NzaC1yc2EAAAIAAHHGUe1nonkjwd+k2TBIYG+pkZml5LWCQV0tjy5xt9z3HeC3bwp5+5co3Pg0rU6Z+/K6skN4HdGp1xn2+VG0yGVvyUQvPIIwBzzNJQWXc+nJrrSH+AS9huF8w00oLL11FJsMwTUC6NhRcRCWBbbRp06db4N3MA+b4UWYmM2gLS9b/9eLq/VR4SPDnChwj1WbCy+VZ7lxVOzRI02qRRd4P0PtSKj/5b+BRLVzsTXO5bPYHvJTDu/gOg8DtKXIhm5Vhmk92fN/9CeN9vYcrjxjjbJoUZa2bG4ISOTxbRzMmO7marFaVmsN/m/MlHIzqmItR8b/PTh6RAw+fZ0Y7LHdFUc1odL0Th0P3JVrdgq9L22D+HhdalHIDGVUTUlKqqtQbR2077OdLzVqDwllspge73oWnoKdJlGD/mZTQHEHgXWI3jFTHLynl1uFXb+tsxb4qO6OLwdqTQypB/o7SiUo2oU/1EcJ6Y85HWlOgbILcOQkKTJiACaN6mp9DrbGZQ//gjc/ZErLn6fMjJ6rgV/ISbhCCLhaKElGxsJovPIDVJJ8zj9B87c3+yNJ6AUIMwMP6zT2hMIaUE5tOh8AeXs905z8Ui4Ze07V29XId1KcR0AwXuel+UfhBTZAhe9OU9BNKWJa4mc/eMu2Q73Lm8+ED1YCv7EPmgvfwdO7sbCF1Gc"
}

Was this page helpful?