Области доступа OAuth
Краткий обзор
- Узнайте, где найти области доступа в JWT и как интерпретировать их составляющие: область, ресурс и действие.
- Разберитесь в назначении стандартных областей доступа OIDC, используемых для идентификации и управления сеансами.
- Изучите текущие области доступа к рабочему пространству и постепенный переход к разграничению прав на чтение и запись для отдельных ресурсов.
Области доступа определяют, какие действия разрешены токену доступа. Altium 365 API проверяет области доступа при каждом запросе — если у токена нет области доступа, необходимой для выполнения операции, возвращается ошибка авторизации.
Области доступа назначаются платформой в зависимости от контекста выдачи токена. Вы не выбираете их вручную, но будете сталкиваться с ними при анализе токенов и работе с API. Понимание структуры областей доступа помогает определить, какие действия разрешены токену, и разобраться в границах доступа.
Области доступа в JWT-токене
Токены доступа имеют формат JWT, и их можно декодировать для просмотра содержащихся в них утверждений (claims). Утверждение scope перечисляет все области доступа, с которыми был выдан токен. Например, токен, выданный для доступа к рабочему пространству, выглядит следующим образом:
{
"scope": [
"openid",
"profile",
"a365:workspace:a9a01426-ac92-480e-9f80-97fe0f8ba344"
]
}
Область доступа a365:workspace:{workspace-id} содержит сведения как об области платформы, к которой предоставляется доступ, так и о конкретном рабочем пространстве, для которого действителен токен.
Правила именования
Области доступа Altium OAuth именуются по следующему шаблону:
area[:resource][.action]
-
area– общая предметная область платформы (например,workspace,global,supply) -
resource– необязательный элемент; конкретный ограниченный контекст или домен данных внутри области (например,design,library,app) -
action– необязательный элемент; тип операции (например,read,write,execute)
Несколько принципов именования:
-
Названия областей основаны на предметных областях, а не на продуктах.
workspace, а неa365;supply, а неoctopart. -
Названия ресурсов соответствуют ограниченным контекстам и устоявшейся терминологии предметной области.
-
Области доступа ориентированы на данные, а не на функциональность.
Область доступа |
Значение |
|
Доступ на чтение к проектным данным в рабочем пространстве |
|
Создание регистраций приложений и управление ими |
|
Доступ на чтение к данным о поставках |
Стандартные области доступа OIDC
Токены также могут содержать стандартные области доступа OIDC, используемые для идентификации и управления сеансами:
Область доступа |
Назначение |
|
Требуется для процессов аутентификации OIDC |
|
Доступ к основной информации профиля пользователя |
|
Доступ к данным о членстве пользователя в группах |
|
Разрешает выдачу токена обновления |
Области доступа рабочего пространства
В настоящее время доступ к данным рабочего пространства представлен единой областью доступа a365:workspace:{workspace-id}, охватывающей все ресурсы рабочего пространства. Платформа переходит к более детализированной модели, в которой доступ можно ограничить конкретными ограниченными контекстами:
Область доступа |
Охватываемые данные |
|
Проекты печатных плат, принципиальные схемы, варианты, выпуски |
|
Компоненты, условные графические обозначения, посадочные места, данные о компонентах |
|
Спецификации, позиции спецификаций |
|
Комментарии, задачи, аннотации |
|
Участники и группы рабочего пространства |
|
Статистика и аналитика рабочего пространства |
|
Интеграции с PLM |
|
Определения и выполнения рабочих процессов |
|
Управление требованиями |
Каждая детализированная область доступа поддерживает действия .read и .write. Более детализированная модель внедряется постепенно — она приводит области доступа в соответствие с моделью ограниченных контекстов API, позволяя предоставлять интеграции доступ только к тем данным, которые ей действительно необходимы.