institutions

Private Account Institution embargo options

Account institution embargo options details

get/account/institution/embargo_options

Request

Base URL
https://api.figshare.com/v2
Auth
OAuth 2
Authorization codehttps://figshare.com/account/applications/authorize
Token URLhttps://api.figshare.com/v2/token
Scopesall
TypeScript
https://skmtc.dev/figshare/apis/figshare-api/docs/account/institution/embargo_options/get.ts
A function with typed inputs. Its response is checked against the schema.

OK. An array of embargo options

idinteger required

Embargo option id

type'logged_in' | 'ip_range' | 'administrator' required

Embargo permission type

ip_namestring required

IP range name; value appears if type is ip_range

[
  {
    "id": 364,
    "type": "ip_range",
    "ip_name": "Figshare IP range"
  }
]

Mar 27, 20265806e3dd43b2 Revision changes
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
Aug 4, 2021b0f8a487a850 Revision changes
- info
  endpoint added