Skip to content

Commit

Permalink
Doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
TheTechArch committed May 28, 2024
1 parent f9705d9 commit a3eca47
Show file tree
Hide file tree
Showing 20 changed files with 277 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,13 @@
{
"ActionId": "complete",
"ActionTitle": "Bekreft mottatt tjenesteeier"
},
{
"ActionId": "subscribe",
"ActionTitle": "Abonnere på hendelser (Events)"
},
{
"ActionId": "publish",
"ActionTitle": "Publisere hendelser (Events)"
}
]
Original file line number Diff line number Diff line change
Expand Up @@ -292,5 +292,17 @@
"SubjectSource": "altinn:rolecode",
"SubjectTitle": "Konkursbo skrivetilgang",
"SubjectDescription": "Utvidet lesetilgang og innsendingsrett for tjenesten Konkursbehandling"
},
{
"SubjectId": "apiadm",
"SubjectSource": "altinn:rolecode",
"SubjectTitle": "Programmeringsgrensesnitt (API)",
"SubjectDescription": "Delegerbar rolle som gir tilgang til å administrere tilgang til programmeringsgrensesnitt - API, på vegne av virksomheten."
},
{
"SubjectId": "apiadnuf",
"SubjectSource": "altinn:rolecode",
"SubjectTitle": "Programmeringsgrensesnitt for NUF (API)",
"SubjectDescription": "Delegerbar rolle som gir kontaktperson for norskregistrert utenlandsk foretak (NUF) tilgang til å administrere tilgang til programmeringsgrensesnitt - API, på vegne av virksomheten."
}
]
126 changes: 126 additions & 0 deletions content/authorization/guides/create-apischeme-resource-admin/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
---
title: Creating and publishing API scheme in altinn Studio
linktitle: Creating Resources
description: This explaines how
toc: false
weight: 1
---


In Altinn Studio Resource admin, you can create resources to use as a basis for access control for services outside of the Altinn Platform.

## Prerequisites

You need to have access to resource administration for your organization. See [Getting started guide](../../getting-started/resource-admin-studio)

## Step 1 Create Resource

Log in to Altinn Studio

Create Resource

The ID given for resource will be the one used in Altinn API for checking access


![Create Resource](create_resource_1.png)


### Resource Type

For external resources, the type will be generic access resource.

### Title

The title will be shown in Access Management and in service catalogues like data.altinn.no

You need to define the title in bokmål, nynorsk and english.

![Create Resource](create_resource_3.png)

### Description

The description will be shown in Access Management and in service catalogues like data.altinn.no

You need to define the description in bokmål, nynorsk and english.

![Create Resource](create_resource_4.png)


### Delegation description

If the resource should be able to be delegated as resource delegation you need to enable the delegation and set delegation description in bokmål, nynorsk and english.

![Create Resource](create_resource_5.png)

### Keywords

Keywords can be set for help. Currently not used but might be used for different service catalogues later

![Create Resource](create_resource_6.png)

### Status

The status of the service that the resource is pointing to

![Create Resource](create_resource_7.png)


### User types

Defines which types of user that can access. This settings does might be used for filtering at a later point. Currently
this is just information.

![Create Resource](create_resource_8.png)


### Party tyoe

Defines what type of party the service is targeting. Might be used for filtering in service catalogue in a later stage.

![Create Resource](create_resource_9.png)

### Contact information

Contact information for the service. Might be presented in service cataloge on a later stage.

![Create Resource](create_resource_10.png)

## Create Policy

When resource is created you need to define the policy.
The policy needs to contain a minimum of 1 rule.

Each rule contains of resource, subject and action

### Resource

Define the resource for the rule
![Create Resource](create_resource_11.png)


### Action

Define the action for the rule

![Create Resource](create_resource_12.png)

### Subject

Define the subject for the role. You can choose amongst ER roles, Altinn Roles, and Access Packages(todo)

![Create Resource](create_resource_13.png)

## Publish

When you have finished setting the resource settings and policy you can publish.
Before publish you need to set a new version ID and commit changes to the resource repository.

![Create Resource](create_resource_14.png)


## Verify

When published the resource is avaiable on the search API in Resource Registry.

Example Resource from guide. [https://platform.tt02.altinn.no/resourceregistry/api/v1/resource/ekstern-tjeneste-portal](https://platform.tt02.altinn.no/resourceregistry/api/v1/resource/ekstern-tjeneste-portal)
Policy for Example resource from this guide [https://platform.tt02.altinn.no/resourceregistry/api/v1/resource/ekstern-tjeneste-portal/policy](https://platform.tt02.altinn.no/resourceregistry/api/v1/resource/ekstern-tjeneste-portal/policy)
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
---
title: Opprette og publisere ressurser i altinn Studio
linktitle: Opprette ressurser
description: Denne guiden forklarer hvordan du kan opprette og publisere ressurser i fra Ressursadministrasjon i Altinn Studio
toc: false
weight: 1
---

I Altinn Studio Resource admin kan du opprette ressurser som skal brukes som grunnlag for tilgangskontroll for tjenester utenfor Altinn-plattformen.

## Forutsetninger

Du må ha tilgang til ressursadministrasjon for organisasjonen din. Se [Kom i gang-veiledningen](../../getting-started/resource-admin-studio)

## Trinn 1 Opprett ressurs

Logg inn i Altinn Studio

Opprett ressurs

IDen som er gitt for ressursen vil være den som brukes i Altinn API for å sjekke tilgang


![Create Resource](create_resource_1.png)


### Ressurstype

For eksterne ressurser vil typen være generisk tilgangsressurs.

### Tittel

Tittelen vil vises i Access Management og i tjenestekataloger som data.altinn.no

Du må definere tittelen på bokmål, nynorsk og engelsk.

![Create Resource](create_resource_3.png)

### Beskrivelse

Beskrivelsen vil vises i Access Management og i tjenestekataloger som data.altinn.no

Du må definere beskrivelsen på bokmål, nynorsk og engelsk.

![Create Resource](create_resource_4.png)


### Delegasjonsbeskrivelse

Dersom ressursen skal kunne delegeres som ressursdelegering må du aktivere delegering og angi delegasjonsbeskrivelse på bokmål, nynorsk og engelsk.

![Create Resource](create_resource_5.png)

### Nøkkelord

Nøkkelord kan angis for hjelp. Foreløpig ikke brukt, men kan brukes til forskjellige tjenestekataloger senere

![Create Resource](create_resource_6.png)

### Status

Statusen til tjenesten som ressursen peker på

![Create Resource](create_resource_7.png)


### Brukertyper

Definerer hvilke typer brukere som har tilgang. Disse innstillingene kan brukes til filtrering på et senere tidspunkt. For tiden
dette er bare informasjon.

![Create Resource](create_resource_8.png)


### Party tyoe

Definerer hvilken type part tjenesten er målrettet mot. Kan brukes til filtrering i servicekatalog på et senere tidspunkt.

![Create Resource](create_resource_9.png)

### Kontaktinformasjon

Kontaktinformasjon for tjenesten. Kan bli presentert i servicekatalog på et senere tidspunkt.

![Create Resource](create_resource_10.png)

## Opprett policy

Når ressursen er opprettet, må du definere policyen.
Policyen må inneholde minst én regel.

Hver regel inneholder ressurs, emne og handling

### Ressurs

Definer ressursen for regelen
![Create Resource](create_resource_11.png)


### Handling

Definer handlingen for regelen

![Create Resource](create_resource_12.png)

### Emne

Definer emnet for rollen. Du kan velge mellom ER-roller, Altinn-roller og tilgangspakker (todo)

![Create Resource](create_resource_13.png)

## Publisere

Når du er ferdig med å angi ressursinnstillingene og policyen kan du publisere.
Før publisering må du angi en ny versjons-ID og foreta endringer i ressurslageret.

![Create Resource](create_resource_14.png)


## Bekrefte

Når den er publisert, er ressursen tilgjengelig på søke-APIet i ressursregisteret.

Eksempel Ressurs fra guide. [https://platform.tt02.altinn.no/resourceregistry/api/v1/resource/ekstern-tjeneste-portal](https://platform.tt02.altinn.no/resourceregistry/api/v1/resource/ekstern- tjeneste-portal)
Retningslinjer for eksempelressurs fra denne veiledningen [https://platform.tt02.altinn.no/resourceregistry/api/v1/resource/ekstern-tjeneste-portal/policy](https://platform.tt02.altinn.no/resourceregistry /api/v1/resource/ekstern-tjeneste-portal/policy)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ The ID given for resource will be the one used in Altinn API for checking access

For external resources, the type will be generic access resource.

![Create Resource](create_resource_2.png)


### Title

The title will be shown in Access Management and in service catalogues like data.altinn.no
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ IDen som er gitt for ressursen vil være den som brukes i Altinn API for å sjek

For eksterne ressurser vil typen være generisk tilgangsressurs.


![Create Resource](create_resource_2.png)

### Tittel

Tittelen vil vises i Access Management og i tjenestekataloger som data.altinn.no
Expand Down

0 comments on commit a3eca47

Please sign in to comment.