Docs

Update OIDCTrust Relationship

puthttps://app.fossa.com/api/oidc/trust-relationships/{id}

Update an existing OIDC Trust Relationship (only audiences and requiredClaims can be updated)

Path parameters

idintegerrequired

The ID of the OIDC Trust Relationship to update

Request body (required) · application/json

audiencesstring[]

Array of valid audiences for this trust relationship

requiredClaimsobject[]

Array of claim objects. Must contain at least one object with claim: "sub". Additional objects with other claims are optional.

claimstringrequired

The claim type identifier

valuestring | number | booleanrequired

The claim value

hasWildcardsboolean

Whether this claim supports wildcard matching. Defaults to false. If true, then the following characters in `value` are treated as special characters: - `?` matches exactly one character - `*` matches zero or more characters - `\` escapes the following character

Responses

200Successfully updated OIDC Trust Relationship
idintegerrequired

The unique identifier of the OIDC Trust Relationship

organizationIdintegerrequired

The ID of the organization this trust relationship belongs to

userIdintegerrequired

The ID of the user associated with this trust relationship

providerIdintegerrequired

The ID of the OIDC Provider this trust relationship uses

scopeenum

The scope level of the trust relationship

orgteam
scopeIdinteger

The ID associated with the scope: either the organization ID or the team ID

audiencesstring[]required

Array of valid audiences for this trust relationship

requiredClaimsobject[]required

Array of claim objects. Must contain at least one object with claim: "sub". Additional objects with other claims are optional.

claimstringrequired

The claim type identifier

valuestring | number | booleanrequired

The claim value

hasWildcardsboolean

Whether this claim supports wildcard matching. Defaults to false. If true, then the following characters in `value` are treated as special characters: - `?` matches exactly one character - `*` matches zero or more characters - `\` escapes the following character

createdAtstring <date-time>required

When the trust relationship was created

updatedAtstring <date-time>required

When the trust relationship was last updated

400Bad Request
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

401Unauthorized
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

403Forbidden
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

404OIDC Trust Relationship not found
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

500Server Error
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

Try this endpoint

Build a request and run it against app.fossa.com.

Bearer

Stored in this browser for 24 hours. Try It uses a docs proxy for CORS and does not store tokens server-side.

PUT https://app.fossa.com/api/oidc/trust-relationships/123
curl --request PUT \  --url 'https://app.fossa.com/api/oidc/trust-relationships/123' \  --header 'accept: application/json' \  --header 'authorization: Bearer YOUR_API_TOKEN' \  --header 'content-type: application/json' \  --data '{  "audiences": [    "https://app.fossa.com",    "fossa"  ],  "requiredClaims": [    {      "claim": "sub",      "value": "repo:fossas/*",      "hasWildcards": true    },    {      "claim": "admin",      "value": true,      "hasWildcards": false    },    {      "claim": "department",      "value": "engineering"    }  ]}'

Real request. Mutating methods can change data.

Click Try It to run a request and see the response here.
Enter a Bearer token before running this request.

Path params

idintegerrequired

The ID of the OIDC Trust Relationship to update

application/json
← All OIDC endpoints